Package com.hp.ucmdb.api

Class UcmdbServiceFactory

java.lang.Object

com.hp.ucmdb.api.UcmdbServiceFactory

public class UcmdbServiceFactory
extends Object

Entry point for UCMDB API services.
To obtain a reference to the UCMDB:
1) Get a reference to UcmdbServiceProvider by calling one of the getServiceProvider methods.
2) Call one of the UcmdbServiceProvider connect methods.

Example:

 final String HOST_NAME = "localhost";
 final int PORT = 8080;
 UcmdbServiceProvider provider = UcmdbServiceFactory.getServiceProvider(HOST_NAME, PORT);
 final String USERNAME = "integration_user";
 final String PASSWORD = "integration_password";
 Credentials credentials = provider.createCredentials(USERNAME, PASSWORD),
 ClientContext clientContext = provider.createClientContext("Example");
 UcmdbService ucmdbService = provider.connect(credentials, clientContext);
 

See Also:

• UcmdbServiceProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UcmdbServiceFactory.AllHostAcceptedVerifier	Disables host name verfication (used in case of NAT networks)
static interface	UcmdbServiceFactory.ConnectionProperties	Internal implementation.
static class	UcmdbServiceFactory.DefaultTruststoreManger	The X509TrustManager implementation.
static interface	UcmdbServiceFactory.HttpBootstrap	Internal implementation.
static interface	UcmdbServiceFactory.HttpUcmdbServiceProviderFactory	Internal implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CERT_CRL_PATH
static final String	CERTIFICATE_FULL_VALIDATION
static final String	KEY_STORE_PASWORD
static final String	KEY_STORE_PATH
static final String	PKIX_CERT_TYPE
static final String	SSL_CHECK_REVOCATION
static final String	TRUST_STORE_PASWORD
static final String	TRUST_STORE_PATH

Method Summary

Modifier and Type	Method	Description
static String	getClientVersion()
static UcmdbServiceProvider	getLocalFirstServiceProvider(String protocol, String host, int port, String rootContext, Proxy proxy)	Returns an instance of a UCMDB service provider from local then remote.
static UcmdbServiceProvider	getLocalFirstServiceProvider(String protocol, String host, int port, String rootContext, Proxy proxy, String apiClientJarFilePath)	Parametric polymorphism of above method
static PKIXBuilderParameters	getPkixBuilderParameters(KeyStore ts, boolean enableCertRevocationChecking)
static UcmdbServiceProvider	getServiceProvider(String host, int port)	Returns an instance of a UCMDB service provider from the specified host and port.
static UcmdbServiceProvider	getServiceProvider(String protocol, String host, int port)
static UcmdbServiceProvider	getServiceProvider(String protocol, String host, int port, String rootContext)	Returns an instance of a UCMDB service provider from the specified host port using the specified protocol.
static UcmdbServiceProvider	getServiceProvider(String protocol, String host, int port, String rootContext, Proxy proxy)	Returns an instance of a UCMDB service provider from the specified host port using the specified protocol.
static UcmdbServiceProvider	getServiceProvider(String protocol, String host, int port, String rootContext, Proxy proxy, SSLContext sslContext)	Returns an instance of a UCMDB service provider from the specified host port using the specified protocol.
static UcmdbServiceProvider	getServiceProvider(String protocol, String host, int port, String rootContext, SSLContext sslContext)	Returns an instance of a UCMDB service provider from the specified host port using the specified protocol.
static void	initSSL()	Initializes the secure socket layer.
static SSLContext	initSSL(SSLContext sslContext)
static Collection<CRL>	loadCRL(List<String> crlPaths)
static String	validateFilePath(String filePath)

Methods inherited from class java.lang.Object

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

Field Details

PKIX_CERT_TYPE

public static final String PKIX_CERT_TYPE

See Also:

• Constant Field Values

CERT_CRL_PATH

public static final String CERT_CRL_PATH

See Also:

• Constant Field Values

KEY_STORE_PATH

public static final String KEY_STORE_PATH

See Also:

• Constant Field Values

TRUST_STORE_PATH

public static final String TRUST_STORE_PATH

See Also:

• Constant Field Values

KEY_STORE_PASWORD

public static final String KEY_STORE_PASWORD

See Also:

• Constant Field Values

TRUST_STORE_PASWORD

public static final String TRUST_STORE_PASWORD

See Also:

• Constant Field Values

SSL_CHECK_REVOCATION

public static final String SSL_CHECK_REVOCATION

See Also:

• Constant Field Values

CERTIFICATE_FULL_VALIDATION

public static final String CERTIFICATE_FULL_VALIDATION

See Also:

• Constant Field Values

Method Details

getClientVersion

public static String getClientVersion()

getServiceProvider

public static UcmdbServiceProvider getServiceProvider(String host,
 int port)
                                               throws MalformedURLException,
IncompatibleVersionException

Returns an instance of a UCMDB service provider from the specified host and port. The connection is made using HTTP.

Parameters:

host - name of the web server host.

port - port the web server listens on. Generally 80 or 8080.

Returns:

an instance of the service provider.

Throws:

MalformedURLException - if the host name results in an invalid URL.

IncompatibleVersionException - if the version of the client is unsupported by the version running on the server.

getServiceProvider

public static UcmdbServiceProvider getServiceProvider(String protocol,
 String host,
 int port,
 String rootContext)
                                               throws MalformedURLException,
IncompatibleVersionException

Returns an instance of a UCMDB service provider from the specified host port using the specified protocol.

Parameters:

protocol - either "http" or "https".

host - name of the web server host.

port - port the web server listens on. Generally 80 or 8080 for http, 443 for https.

Returns:

an instance of the service provider.

Throws:

MalformedURLException - if the host name results in an invalid URL.

IncompatibleVersionException - if the version of the client is unsupported by the version running on the server.

getLocalFirstServiceProvider

public static UcmdbServiceProvider getLocalFirstServiceProvider(String protocol,
 String host,
 int port,
 String rootContext,
 Proxy proxy)

Returns an instance of a UCMDB service provider from local then remote.

Parameters:

protocol - either "http" or "https".

host - name of the web server host.

port - port the web server listens on. Generally 80 or 8080 for http, 443 for https.

Returns:

an instance of the service provider.

Throws:

MalformedURLException - if the host name results in an invalid URL.

IncompatibleVersionException - if the version of the client is unsupported by the version running on the server.

getLocalFirstServiceProvider

public static UcmdbServiceProvider getLocalFirstServiceProvider(String protocol,
 String host,
 int port,
 String rootContext,
 Proxy proxy,
 String apiClientJarFilePath)

Parametric polymorphism of above method

Parameters:

apiClientJarFilePath - indicates where api client jar file lies.

getServiceProvider

public static UcmdbServiceProvider getServiceProvider(String protocol,
 String host,
 int port,
 String rootContext,
 Proxy proxy)
                                               throws MalformedURLException

Returns an instance of a UCMDB service provider from the specified host port using the specified protocol.

Parameters:

protocol - either "http" or "https".

host - name of the web server host.

port - port the web server listens on. Generally 80 or 8080 for http, 443 for https.

proxy - the Proxy through which this connection will be made.

Returns:

an instance of the service provider.

Throws:

MalformedURLException - if the host name results in an invalid URL.

IncompatibleVersionException - if the version of the client is unsupported by the version running on the server.

getServiceProvider

public static UcmdbServiceProvider getServiceProvider(String protocol,
 String host,
 int port,
 String rootContext,
 SSLContext sslContext)
                                               throws MalformedURLException

Returns an instance of a UCMDB service provider from the specified host port using the specified protocol.

Parameters:

protocol - either "http" or "https".

host - name of the web server host.

port - port the web server listens on. Generally 80 or 8080 for http, 443 for https.

sslContext - the Proxy through which this connection will be made.

Returns:

an instance of the service provider.

Throws:

MalformedURLException - if the host name results in an invalid URL.

IncompatibleVersionException - if the version of the client is unsupported by the version running on the server.

getServiceProvider

public static UcmdbServiceProvider getServiceProvider(String protocol,
 String host,
 int port,
 String rootContext,
 Proxy proxy,
 SSLContext sslContext)
                                               throws MalformedURLException

Returns an instance of a UCMDB service provider from the specified host port using the specified protocol.

Parameters:

protocol - either "http" or "https".

host - name of the web server host.

port - port the web server listens on. Generally 80 or 8080 for http, 443 for https.

proxy - the Proxy through which this connection will be made.

sslContext - the sslCntext through which this connection will be made.

Returns:

an instance of the service provider.

Throws:

MalformedURLException - if the host name results in an invalid URL.

IncompatibleVersionException - if the version of the client is unsupported by the version running on the server.

getServiceProvider

public static UcmdbServiceProvider getServiceProvider(String protocol,
 String host,
 int port)
                                               throws MalformedURLException,
IncompatibleVersionException

Throws:

MalformedURLException

IncompatibleVersionException

initSSL

public static void initSSL()

Initializes the secure socket layer.

initSSL

public static SSLContext initSSL(SSLContext sslContext)

getPkixBuilderParameters

public static PKIXBuilderParameters getPkixBuilderParameters(KeyStore ts,
 boolean enableCertRevocationChecking)
                                                      throws Exception

Throws:

Exception

loadCRL

public static Collection<CRL> loadCRL(List<String> crlPaths)
                               throws IOException,
CertificateException,
CRLException

Throws:

IOException

CertificateException

CRLException

validateFilePath

public static String validateFilePath(String filePath)
                               throws IOException

Throws:

IOException