org.apache.ambari.server.state.kerberos

Class KerberosServiceDescriptorFactory

java.lang.Object

org.apache.ambari.server.state.kerberos.KerberosServiceDescriptorFactory

public class KerberosServiceDescriptorFactory
extends Object

KerberosServiceDescriptorFactory is a factory class used to create KerberosServiceDescriptor instances using various sources of data.

Constructor Summary

Constructors

Constructor and Description
KerberosServiceDescriptorFactory()

Method Summary

Modifier and Type	Method and Description
KerberosServiceDescriptor	createInstance(File file, String name) Creates the requested KerberosServiceDescriptor parsed from a JSON-formatted file.
KerberosServiceDescriptor	createInstance(Map<String,Object> map, String name) Creates the requested KerberosServiceDescriptor parsed from a Map of data.
KerberosServiceDescriptor	createInstance(String name, Map<?,?> map) Creates a new KerberosServiceDescriptor
KerberosServiceDescriptor	createInstance(String name, String json) Creates a new KerberosServiceDescriptor
KerberosServiceDescriptor[]	createInstances(File file) Creates a Collection of KerberosServiceDescriptors parsed from a JSON-formatted file.
KerberosServiceDescriptor[]	createInstances(Map<String,Object> map) Creates a Collection of KerberosServiceDescriptors parsed from a Map of data.
KerberosServiceDescriptor[]	createInstances(String json) Creates a Collection of KerberosServiceDescriptors parsed from a JSON-formatted String.
protected Map<String,Object>	parseFile(File file) Parses a file containing JSON-formatted text into a (generic) Map.
protected Map<String,Object>	parseJSON(String json) Parses a JSON-formatted String into a (generic) Map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KerberosServiceDescriptorFactory

public KerberosServiceDescriptorFactory()

Method Detail

createInstances

public KerberosServiceDescriptor[] createInstances(File file)
                                            throws IOException

Creates a Collection of KerberosServiceDescriptors parsed from a JSON-formatted file.

The file is expected to be formatted as follows:

 {
    "services" : [
      ... (zero or more service descriptor blocks) ...
    ]
 }
 

Parameters:

file - a JSON-formatted file containing this service-level descriptor data

Returns:

an array of KerberosServiceDescriptor objects

Throws:

FileNotFoundException - if the specified File does not point to a valid file

IOException - if the specified File is not a readable file

org.apache.ambari.server.AmbariException - if the specified File does not contain valid JSON data

See Also:

KerberosServiceDescriptor

createInstances

public KerberosServiceDescriptor[] createInstances(String json)
                                            throws org.apache.ambari.server.AmbariException

Creates a Collection of KerberosServiceDescriptors parsed from a JSON-formatted String.

The String is expected to be formatted as follows:

 {
    "services" : [
      ... (zero or more service descriptor blocks) ...
    ]
 }
 

Parameters:

json - a JSON-formatted String containing this service-level descriptor data

Returns:

an array of KerberosServiceDescriptor objects

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while processing the JSON-formatted String

See Also:

KerberosServiceDescriptor

createInstances

public KerberosServiceDescriptor[] createInstances(Map<String,Object> map)
                                            throws org.apache.ambari.server.AmbariException

Creates a Collection of KerberosServiceDescriptors parsed from a Map of data.

The Map is expected to be formatted as follows:

 "services" => [
   ... (zero or more Maps containing service descriptor data) ...
 ]
 

Parameters:

map - a Map containing this service-level descriptor data

Returns:

an array of KerberosServiceDescriptor objects

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while processing the Map

See Also:

KerberosServiceDescriptor

createInstance

public KerberosServiceDescriptor createInstance(File file,
                                                String name)
                                         throws IOException

Creates the requested KerberosServiceDescriptor parsed from a JSON-formatted file.

The file is expected to be formatted as follows:

 {
    "services" : [
      ... (zero or more service descriptor blocks) ...
    ]
 }
 

Because of this one or more services may exist. This method parses through the definitions to return the a KerberosServiceDescriptor for the requested service

Parameters:

file - a JSON-formatted file containing this service-level descriptor data

name - a String containing the nae of the desired service

Returns:

a KerberosServiceDescriptor object or null if a descriptor for the named service is not available

Throws:

FileNotFoundException - if the specified File does not point to a valid file

IOException - if the specified File is not a readable file

org.apache.ambari.server.AmbariException - if the specified File does not contain valid JSON data

See Also:

KerberosServiceDescriptor

createInstance

public KerberosServiceDescriptor createInstance(Map<String,Object> map,
                                                String name)
                                         throws org.apache.ambari.server.AmbariException

Creates the requested KerberosServiceDescriptor parsed from a Map of data.

The Map is expected to be formatted as follows:

 "services" => [
   ... (zero or more Maps containing service descriptor data) ...
 ]
 

Because of this one or more services may exist. This method parses through the definitions to return the a KerberosServiceDescriptor for the requested service

Parameters:

map - a Map containing this service-level descriptor data

name - a String containing the nae of the desired service

Returns:

a KerberosServiceDescriptor object or null if a descriptor for the named service is not available

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while processing the Map

See Also:

KerberosServiceDescriptor

createInstance

public KerberosServiceDescriptor createInstance(String name,
                                                String json)
                                         throws org.apache.ambari.server.AmbariException

Creates a new KerberosServiceDescriptor

Parameters:

name - a String declaring this service's name

json - a JSON-formatted String containing this service's descriptor data

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while parsing the JSON-formatted String

See Also:

KerberosServiceDescriptor

createInstance

public KerberosServiceDescriptor createInstance(String name,
                                                Map<?,?> map)
                                         throws org.apache.ambari.server.AmbariException

Creates a new KerberosServiceDescriptor

Parameters:

name - a String declaring this service's name

map - a Map of values use to populate the data for the new instance

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while parsing the JSON-formatted String

See Also:

KerberosServiceDescriptor

parseFile

protected Map<String,Object> parseFile(File file)
                                throws IOException

Parses a file containing JSON-formatted text into a (generic) Map.

Parameters:

file - a File containing the JSON-formatted text to parse

Returns:

a Map of the data

Throws:

FileNotFoundException - if the specified File does not point to a valid file

IOException - if the specified File is not a readable file

org.apache.ambari.server.AmbariException - if the specified File does not contain valid JSON data

parseJSON

protected Map<String,Object> parseJSON(String json)
                                throws org.apache.ambari.server.AmbariException

Parses a JSON-formatted String into a (generic) Map.

Parameters:

json - a String containing the JSON-formatted text to parse

Returns:

a Map of the data

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while parsing the JSON-formatted String