Skip navigation links

oracle.ocsg.plugin.connection.management
Interface ConnectInfoManagerMBean

public interface ConnectInfoManagerMBean

Exposes connection info of remote hosts (aka, network node / smsc) and listen address details of ServerService

Field Summary

static boolean

validationEnabled Defines if the ConnectInfoManager validates the parameters when executing operations.

Method Summary

Credential	addXParamToCredentialEntry(String credentialId, String xParamName, String xParamValue) Add extra parameter values to credential mapping.
Map	createOrUpdateCredentialMap(String pluginInstanceId, String appId, String credentialId) Creates a new entry or updates an existing entry in the credential map associated with the given pluginInstanceId.
void	createOrUpdateListenAddress(String protocol, String host, int port, String targets) Add a listen address configuration.
void	createOrUpdateLocalHostAddress(String pluginInstanceId, String localHost, int localPort, String targets)
void	createOrUpdateRemoteHostAddress(String pluginInstanceId, String remoteHost, int remotePort) Create or Update the connection details to the remote host to which the plugin should connect.
Credential	createOrUpdateUserPasswordCredentialEntry(String credentialId, String remoteUser, String remotePassword) Creates or updates the user and password parameters associated with the specified credentialId.
Set	getAllListenAddress(String protocol) Returns a list of ServerAddress configured for this domain for the given protocol.
ConnectInfo	getConnectInfo(String pluginInstanceId) Returns the ConnectInfo of the remote host (SMSC / network node).
Set	getListenAddressForCurrentServer(String protocol) Returns a list of ServerAddresses configured for the current server for the given protocol This is a convenience method for the caller to get a subset of configured listen addresses which are targeted to the current server
boolean	isValidationEnabled() Returns a boolean indicating whether validation is enabled.
Map	listAllCredentialEntries() Gives a map of credentialIds and the associated Credential objects in the configuration.
void	removeConnectInfo(String pluginInstanceId) Remove the remote host's connect address, local connect address along with credential mapping for the given pluginInstanceId.
void	removeCredentialEntry(String credentialId) Removes the credential entry
void	removeCredentialMap(String pluginInstanceId, String appId) Remove the credential association between the given appId and the associated credential, if any, from the given pluginInstanceId's connect info configuration.
void	removeListenAddress(String protocol, String host, int port) Removes this listen address configuration from all the targets.
void	removeLocalHostAddress(String pluginInstanceId) Remove the local host address info associated with this pluginInstanceId.
Credential	removeXParamFromCredentialEntry(String credentialId, String xParamName) Removes the extra parameter associated with the given credentialId.
void	setValidationEnabled(boolean enabled) Setter to enable validation of targets and pluginInstanceIds.

Field Detail

validationEnabled

public static final boolean validationEnabled

Defines if the ConnectInfoManager validates the parameters when executing operations. For example, it can check if instance exists when the createOrUpdateRemoteHostAddress operation is executed.

See Also:

Constant Field Values

Method Detail

addXParamToCredentialEntry

public Credential addXParamToCredentialEntry(String credentialId,
                                             String xParamName,
                                             String xParamValue)
                                      throws ManagementException

Add extra parameter values to credential mapping. This method can be used to add any 'name - value' pair. For example, the UCP service may store connection-specific windowing parameters using this operation.

Parameters:

credentialId - - Unique identifier for the credential in the configuration

xParamName -

xParamValue -

Throws:

ManagementException

createOrUpdateCredentialMap

public Map createOrUpdateCredentialMap(String pluginInstanceId,
                                       String appId,
                                       String credentialId)
                                throws ManagementException

Creates a new entry or updates an existing entry in the credential map associated with the given pluginInstanceId.

Parameters:

pluginInstanceId -

appId - - application instance Id/ocsg user who needs to be mapped to the remote host

credentialId - - Id of an existing credential entry in the configuration. If this value is empty or null, the existing mapping if any for the given appId is removed. If this value doesn't match any of the existing credentialId, ManagementException will be thrown

Returns:

Returns a map of appId to credentialId for this pluginInstanceId

Throws:

ManagementException

createOrUpdateListenAddress

public void createOrUpdateListenAddress(String protocol,
                                        String host,
                                        int port,
                                        String targets)
                                 throws ManagementException

Add a listen address configuration. If this listen address is already present then its target list is changed to the new value passed with this call.

Parameters:

protocol - - Name of the protocol, like, ucp or smpp

host - - Host name or IP address

port - - port number to bind to

targets - - server names or cluster name - comma separated. If left blank, this config will be applicable to all the targets in the cluster

Throws:

ManagementException

createOrUpdateLocalHostAddress

public void createOrUpdateLocalHostAddress(String pluginInstanceId,
                                           String localHost,
                                           int localPort,
                                           String targets)
                                    throws ManagementException

Parameters:

pluginInstanceId -

localHost -

localPort - - this will be used as the starting port in cases where multiple connections need to be opened to the remote host. The local port number will be incremented by 1 for additional connections.

targets - - server names or cluster name - comma separated. If left blank, this config will be applicable to all the targets in the cluster.

Throws:

ManagementException

createOrUpdateRemoteHostAddress

public void createOrUpdateRemoteHostAddress(String pluginInstanceId,
                                            String remoteHost,
                                            int remotePort)
                                     throws ManagementException

Create or Update the connection details to the remote host to which the plugin should connect.

Parameters:

pluginInstanceId -

remoteHost -

remotePort -

Throws:

ManagementException

createOrUpdateUserPasswordCredentialEntry

public Credential createOrUpdateUserPasswordCredentialEntry(String credentialId,
                                                            String remoteUser,
                                                            String remotePassword)
                                                     throws ManagementException

Creates or updates the user and password parameters associated with the specified credentialId.

Parameters:

credentialId - - Unique identifier for the credential in the configuration

remoteUser - Value of the attribute 'user'

remotePassword - Value of the attribute 'password'

Throws:

ManagementException

getAllListenAddress

public Set getAllListenAddress(String protocol)
                        throws ManagementException

Returns a list of ServerAddress configured for this domain for the given protocol.

Parameters:

protocol -

Returns:

list of ServerAddresses configured for this domain for the given protocol.

Throws:

ManagementException

getConnectInfo

public ConnectInfo getConnectInfo(String pluginInstanceId)
                           throws ManagementException

Returns the ConnectInfo of the remote host (SMSC / network node). The ConnectInfo includes the remoteHost, remotePort, localHost, localPort and credentialMap. The localHost and localPort values are server-specific. The returned values are specific to the server where this MBean instance resides.

Parameters:

pluginInstanceId -

Returns:

the ConnectInfo of the remote host

Throws:

ManagementException

getListenAddressForCurrentServer

public Set getListenAddressForCurrentServer(String protocol)
                                     throws ManagementException

Returns a list of ServerAddresses configured for the current server for the given protocol This is a convenience method for the caller to get a subset of configured listen addresses which are targeted to the current server

Parameters:

protocol -

Returns:

list of ServerAddress.

Throws:

ManagementException

isValidationEnabled

public boolean isValidationEnabled()

Returns a boolean indicating whether validation is enabled. Validation is enabled by default.

Returns:

True if validation is enabled, false if not.

listAllCredentialEntries

public Map listAllCredentialEntries()
                             throws ManagementException

Gives a map of credentialIds and the associated Credential objects in the configuration.

Returns:

Map containing all the credentialId to Credential mappings

Throws:

ManagementException

removeConnectInfo

public void removeConnectInfo(String pluginInstanceId)
                       throws ManagementException

Remove the remote host's connect address, local connect address along with credential mapping for the given pluginInstanceId.

Parameters:

pluginInstanceId -

Throws:

ManagementException

removeCredentialEntry

public void removeCredentialEntry(String credentialId)
                           throws ManagementException

Removes the credential entry

Parameters:

credentialId - - Unique identifier for the credential in the configuration

Throws:

ManagementException

removeCredentialMap

public void removeCredentialMap(String pluginInstanceId,
                                String appId)
                         throws ManagementException

Remove the credential association between the given appId and the associated credential, if any, from the given pluginInstanceId's connect info configuration.

Parameters:

pluginInstanceId -

appId -

Throws:

ManagementException

removeListenAddress

public void removeListenAddress(String protocol,
                                String host,
                                int port)
                         throws ManagementException

Removes this listen address configuration from all the targets.

Parameters:

protocol -

host -

port -

Throws:

ManagementException

removeLocalHostAddress

public void removeLocalHostAddress(String pluginInstanceId)
                            throws ManagementException

Remove the local host address info associated with this pluginInstanceId.

Parameters:

pluginInstanceId -

Throws:

ManagementException

removeXParamFromCredentialEntry

public Credential removeXParamFromCredentialEntry(String credentialId,
                                                  String xParamName)
                                           throws ManagementException

Removes the extra parameter associated with the given credentialId.

Parameters:

credentialId -

xParamName -

Returns:

Credential associated with the credentialId

Throws:

ManagementException

setValidationEnabled

public void setValidationEnabled(boolean enabled)

Setter to enable validation of targets and pluginInstanceIds. If this flag is enabled, then PluginManagerMBean is used to check the validity of the plug-in instance id before creating the configuration. The server names are validated based on the domain configuration.

Parameters:

enabled - True if plug-in instance validation should be done

Skip navigation links