com.basis.api.admin

Class BBjAdminFactory

java.lang.Object

com.basis.api.admin.BBjAdminFactory

public abstract class BBjAdminFactory
extends java.lang.Object

Factory class for BBjAdmin.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BBjAdminFactory.BBjAdminImplConnection
static class	BBjAdminFactory.BBjAdminImplConnectionStream
static class	BBjAdminFactory.BBjAdminStubConnection

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BBJADMIN_REMOTE_HANDLE
static int	DEFAULT_PORT
static int	DEFAULT_TIMEOUT
static int	PROTOCOL_VERSION

Constructor Summary

Constructors

Constructor and Description
BBjAdminFactory()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAuthToken(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_user, java.lang.String p_password, java.util.Locale p_locale) Get a BBjAdmin object for a remote BBjServices on the specified port.
static java.lang.String	getAuthToken(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_user, java.lang.String p_password, java.util.Locale p_locale, java.lang.String p_keystore, java.lang.String p_keypass)
static java.lang.String	getAuthToken(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_user, java.lang.String p_password) Get a BBjAdmin object for a remote BBjServices on the specified port.
static java.lang.String	getAuthToken(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_user, java.lang.String p_password, java.lang.String p_keystore, java.lang.String p_keypass) Get a BBjAdmin object for a remote BBjServices on the specified port.
static java.lang.String	getAuthToken(java.net.InetAddress p_host, java.lang.String p_user, java.lang.String p_password) Get a BBjAdmin object for a remote BBjServices on the default port.
static java.lang.String	getAuthToken(java.lang.String p_user, java.lang.String p_password) Get a default BBjAdmin object.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_authorizationToken) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_user, java.lang.String p_password) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_user, java.lang.String p_password, java.util.Locale p_locale) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_user, java.lang.String p_password, java.util.Locale p_locale, java.lang.String p_keystore, java.lang.String p_keypass) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_user, java.lang.String p_password, java.lang.String p_keystore, java.lang.String p_keypass) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_token)
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_user, java.lang.String p_password) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_user, java.lang.String p_password, java.util.Locale p_locale) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_user, java.lang.String p_password, java.util.Locale p_locale, java.lang.String p_keystore, java.lang.String p_keypass) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_user, java.lang.String p_password, java.lang.String p_keystore, java.lang.String p_keypass) Get a BBjAdmin object for a remote BBjServices on the specified port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, java.lang.String p_authorizationToken) Get a BBjAdmin object for a remote BBjServices on the default port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, java.lang.String p_user, java.lang.String p_password) Get a BBjAdmin object for a remote BBjServices on the default port.
static BBjAdminBase	getBBjAdmin(java.net.InetAddress p_host, java.lang.String p_user, java.lang.String p_password, java.util.Locale p_locale) Get a BBjAdmin object for a remote BBjServices on the default port.
static BBjAdminBase	getBBjAdmin(java.lang.String p_authorizationToken) Get a default BBjAdmin object.
static BBjAdminBase	getBBjAdmin(java.lang.String p_user, java.lang.String p_password) Get a default BBjAdmin object.
static BBjAdminBase	getBBjAdmin(java.lang.String p_user, java.lang.String p_password, java.net.InetAddress p_serverHost, int p_serverPort, java.net.InetAddress p_clientHost, int p_clientPort) Get a default BBjAdmin object.
static BBjAdminBase	getBBjAdmin(java.lang.String p_user, java.lang.String p_password, java.net.InetAddress p_serverHost, int p_serverPort, java.net.InetAddress p_clientHost, int p_clientPort, java.util.Locale p_locale) Get a default BBjAdmin object.
static BBjAdminBase	getBBjAdmin(java.lang.String p_user, java.lang.String p_password, java.util.Locale p_locale) Get a default BBjAdmin object.
static java.lang.String	renewAuthToken(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_authorizationToken, java.util.Locale p_locale) Get a BBjAdmin object for a remote BBjServices on the specified port.
static java.lang.String	renewAuthToken(java.net.InetAddress p_host, int p_port, boolean p_ssl, int p_timeout, java.lang.String p_authorizationToken, java.util.Locale p_locale, java.lang.String p_keystore, java.lang.String p_keypass)
static java.lang.String	renewAuthToken(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_authorizationToken) Get a BBjAdmin object for a remote BBjServices on the specified port.
static java.lang.String	renewAuthToken(java.net.InetAddress p_host, int p_port, boolean p_ssl, java.lang.String p_authorizationToken, java.lang.String p_keystore, java.lang.String p_keypass) Get a BBjAdmin object for a remote BBjServices on the specified port.
static java.lang.String	renewAuthToken(java.net.InetAddress p_host, java.lang.String p_authorizationToken) Get a BBjAdmin object for a remote BBjServices on the default port.
static java.lang.String	renewAuthToken(java.lang.String p_authorizationToken) Get a default BBjAdmin object.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

PROTOCOL_VERSION

public static final int PROTOCOL_VERSION

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

BBJADMIN_REMOTE_HANDLE

public static final java.lang.String BBJADMIN_REMOTE_HANDLE

See Also:

Constant Field Values

Constructor Detail

BBjAdminFactory

public BBjAdminFactory()

Method Detail

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.util.Locale p_locale)
                                throws BBjAdminException

Get a default BBjAdmin object. This is primarily used to get a local BBjAdmin object when running in the same JVM as BBjServices.

Parameters:

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.lang.String p_user,
                                       java.lang.String p_password)
                                throws BBjAdminException

Get a default BBjAdmin object. This is primarily used to get a local BBjAdmin object when running in the same JVM as BBjServices.

Parameters:

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.lang.String p_authorizationToken)
                                throws BBjAdminException

Get a default BBjAdmin object. This is primarily used to get a local BBjAdmin object when running in the same JVM as BBjServices.

Parameters:

p_authorizationToken - Token identifying the user. This should be acquired with a call to getAuthToken().

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.net.InetAddress p_serverHost,
                                       int p_serverPort,
                                       java.net.InetAddress p_clientHost,
                                       int p_clientPort,
                                       java.util.Locale p_locale)
                                throws BBjAdminException

Get a default BBjAdmin object. This is primarily used to get a local BBjAdmin object when running in the same JVM as BBjServices.

Parameters:

p_user - User name.

p_password - User password.

p_serverHost -

p_serverPort -

p_clientHost -

p_clientPort -

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.net.InetAddress p_serverHost,
                                       int p_serverPort,
                                       java.net.InetAddress p_clientHost,
                                       int p_clientPort)
                                throws BBjAdminException

Get a default BBjAdmin object. This is primarily used to get a local BBjAdmin object when running in the same JVM as BBjServices.

Parameters:

p_user - User name.

p_password - User password.

p_serverHost -

p_serverPort -

p_clientHost -

p_clientPort -

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.util.Locale p_locale)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the default port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       java.lang.String p_user,
                                       java.lang.String p_password)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the default port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       java.lang.String p_authorizationToken)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the default port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_authorizationToken - Token identifying the user. This should be acquired via a call to getAuthToken().

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.util.Locale p_locale)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.util.Locale p_locale,
                                       java.lang.String p_keystore,
                                       java.lang.String p_keypass)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_user - User name.

p_password - User password.

p_keystore - Keystore for SSL/TLS certificate validation (null uses default validation).

p_keypass - Password for keystore.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       java.lang.String p_user,
                                       java.lang.String p_password)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       java.lang.String p_token)
                                throws BBjAdminException

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.lang.String p_keystore,
                                       java.lang.String p_keypass)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_user - User name.

p_password - User password.

p_keystore - Keystore for SSL/TLS certificate validation (null uses default validation).

p_keypass - Password for keystore.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       int p_timeout,
                                       java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.util.Locale p_locale)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_timeout - Connection timeout in milliseconds. A timeout of less than or equal to 0 disables the timeout.

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       int p_timeout,
                                       java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.util.Locale p_locale,
                                       java.lang.String p_keystore,
                                       java.lang.String p_keypass)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_timeout - Connection timeout in milliseconds. A timeout of less than or equal to 0 disables the timeout.

p_user - User name.

p_password - User password.

p_keystore - Keystore for SSL/TLS certificate validation (null uses default validation).

p_keypass - Password for keystore.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       int p_timeout,
                                       java.lang.String p_user,
                                       java.lang.String p_password)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_timeout - Connection timeout in milliseconds. A timeout of less than or equal to 0 disables the timeout.

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       int p_timeout,
                                       java.lang.String p_authorizationToken)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_timeout - Connection timeout in milliseconds. A timeout of less than or equal to 0 disables the timeout.

p_authorizationToken - Token identifying the user. This should be acquired via a call to getAuthToken().

Throws:

BBjAdminException

getBBjAdmin

public static BBjAdminBase getBBjAdmin(java.net.InetAddress p_host,
                                       int p_port,
                                       boolean p_ssl,
                                       int p_timeout,
                                       java.lang.String p_user,
                                       java.lang.String p_password,
                                       java.lang.String p_keystore,
                                       java.lang.String p_keypass)
                                throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_timeout - Connection timeout in milliseconds. A timeout of less than or equal to 0 disables the timeout.

p_user - User name.

p_password - User password.

p_keystore - Keystore for SSL/TLS certificate validation (null uses default validation).

p_keypass - Password for keystore.

Throws:

BBjAdminException

getAuthToken

public static java.lang.String getAuthToken(java.lang.String p_user,
                                            java.lang.String p_password)
                                     throws BBjAdminException

Get a default BBjAdmin object. This is primarily used to get a local BBjAdmin object when running in the same JVM as BBjServices.

Parameters:

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getAuthToken

public static java.lang.String getAuthToken(java.net.InetAddress p_host,
                                            java.lang.String p_user,
                                            java.lang.String p_password)
                                     throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the default port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getAuthToken

public static java.lang.String getAuthToken(java.net.InetAddress p_host,
                                            int p_port,
                                            boolean p_ssl,
                                            java.lang.String p_user,
                                            java.lang.String p_password)
                                     throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getAuthToken

public static java.lang.String getAuthToken(java.net.InetAddress p_host,
                                            int p_port,
                                            boolean p_ssl,
                                            java.lang.String p_user,
                                            java.lang.String p_password,
                                            java.lang.String p_keystore,
                                            java.lang.String p_keypass)
                                     throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_user - User name.

p_password - User password.

p_keystore - Keystore for SSL/TLS certificate validation (null uses default validation).

p_keypass - Password for keystore.

Throws:

BBjAdminException

getAuthToken

public static java.lang.String getAuthToken(java.net.InetAddress p_host,
                                            int p_port,
                                            boolean p_ssl,
                                            int p_timeout,
                                            java.lang.String p_user,
                                            java.lang.String p_password,
                                            java.util.Locale p_locale)
                                     throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_timeout - Connection timeout in milliseconds. A timeout of less than or equal to 0 disables the timeout.

p_user - User name.

p_password - User password.

Throws:

BBjAdminException

getAuthToken

public static java.lang.String getAuthToken(java.net.InetAddress p_host,
                                            int p_port,
                                            boolean p_ssl,
                                            int p_timeout,
                                            java.lang.String p_user,
                                            java.lang.String p_password,
                                            java.util.Locale p_locale,
                                            java.lang.String p_keystore,
                                            java.lang.String p_keypass)
                                     throws BBjAdminException

Throws:

BBjAdminException

renewAuthToken

public static java.lang.String renewAuthToken(java.net.InetAddress p_host,
                                              int p_port,
                                              boolean p_ssl,
                                              int p_timeout,
                                              java.lang.String p_authorizationToken,
                                              java.util.Locale p_locale,
                                              java.lang.String p_keystore,
                                              java.lang.String p_keypass)
                                       throws BBjAdminException

Throws:

BBjAdminException

renewAuthToken

public static java.lang.String renewAuthToken(java.lang.String p_authorizationToken)
                                       throws BBjAdminException

Get a default BBjAdmin object. This is primarily used to get a local BBjAdmin object when running in the same JVM as BBjServices.

Parameters:

p_authorizationToken - Token to be renewed.

Throws:

BBjAdminException

renewAuthToken

public static java.lang.String renewAuthToken(java.net.InetAddress p_host,
                                              java.lang.String p_authorizationToken)
                                       throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the default port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_authorizationToken - Token to be renewed.

Throws:

BBjAdminException

renewAuthToken

public static java.lang.String renewAuthToken(java.net.InetAddress p_host,
                                              int p_port,
                                              boolean p_ssl,
                                              java.lang.String p_authorizationToken)
                                       throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_authorizationToken -

Throws:

BBjAdminException

renewAuthToken

public static java.lang.String renewAuthToken(java.net.InetAddress p_host,
                                              int p_port,
                                              boolean p_ssl,
                                              java.lang.String p_authorizationToken,
                                              java.lang.String p_keystore,
                                              java.lang.String p_keypass)
                                       throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port. This uses the default timeout of five seconds.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_authorizationToken -

p_keystore - Keystore for SSL/TLS certificate validation (null uses default validation).

p_keypass - Password for keystore.

Throws:

BBjAdminException

renewAuthToken

public static java.lang.String renewAuthToken(java.net.InetAddress p_host,
                                              int p_port,
                                              boolean p_ssl,
                                              int p_timeout,
                                              java.lang.String p_authorizationToken,
                                              java.util.Locale p_locale)
                                       throws BBjAdminException

Get a BBjAdmin object for a remote BBjServices on the specified port.

Parameters:

p_host - Remote host.

p_port - Remote port.

p_ssl - Should we use SSL to connect?

p_timeout - Connection timeout in milliseconds. A timeout of less than or equal to 0 disables the timeout.

p_authorizationToken -

Throws:

BBjAdminException