Skip navigation links

oracle.ocsg.plugin.connection.management
Interface ConnectInfoManagerMBean

public interface ConnectInfoManagerMBean

Exposes connection info of remote hosts (network node or SMSC) and listen address details of ServerService.

Field Summary

static boolean

validationEnabled If set to true, the Plug-in Manager validates the plug-in instance ID before the Connection Information Manager creates an entry for it in the credential map.

Method Summary

Credential	addXParamToCredentialEntry(String credentialId, String xParamName, String xParamValue) Adds 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 pluginInstanceId.
void	createOrUpdateListenAddress(String protocol, String host, int port, String targets) Adds a listen address configuration.
void	createOrUpdateLocalHostAddress(String pluginInstanceId, String localHost, int localPort, String targets) Adds a local host address or updates an existing entry.
void	createOrUpdateRemoteHostAddress(String pluginInstanceId, String remoteHost, int remotePort) Creates or updates the connection details for the remote host to which the specified plug-in instance connects.
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) for the server on which this MBean resides.
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) Removes the remote host's connect address, local connect address along with credential mapping for the given pluginInstanceId.
void	removeCredentialEntry(String credentialId) Removes the specified credential entry from the configuration.
void	removeCredentialMap(String pluginInstanceId, String appId) Removes 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) Removes 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

If set to true, the Plug-in Manager validates the plug-in instance ID before the Connection Information Manager creates an entry for it in the credential map. It also validates the server names and cluster names targets passed in the targets parameters to the createOrUpdateListenAddress and createOrUpdateLocalHostAddress methods.

Scope: Cluster

See Also:

Constant Field Values

Method Detail

addXParamToCredentialEntry

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

Adds extra parameter values to credential mapping. This method can be used to add any 'name - value' pair. For example, native UCP can use this operation to provide connection-specific windowing and heartbeat parameters.

Scope: Cluster

Parameters:

credentialId - - Unique identifier for the credential in the configuration.

xParamName - User-defined name for the parameter

xParamValue - Value of the parameter

Throws:

ManagementException.

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 pluginInstanceId. This method creates the association between a plug-in instance, an application instance, and a credential ID. For credential maps configured for use by native UCP, the appId must be a numeric string with a maximum length of 16 digits that maps to the OAdC field in the UCP openSession request.

Scope: Cluster

Parameters:

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.

ManagementException

createOrUpdateListenAddress

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

Adds 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.

Scope: Cluster

Parameters:

protocol - - Name of the protocol, for example UCP or SMPP

host - - Host name or IP address. Defaults to localhost

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.

ManagementException

createOrUpdateLocalHostAddress

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

Adds a local host address or updates an existing entry. A configured local host address is optional. When Services Gatekeeper connects to the remote network node, it uses the specified local host IP address/port combination to bind the socket on the Services Gatekeeper side of the connection. If the local host address is not configured, an ephemeral port is used. When multiple connections are established with a network element, the port set by this operation is used as the starting offset. When this operation is used to update an existing entry, the target list is changed to the new targets value passed by this call.

Scope: Cluster

Parameters:

pluginInstanceId - plugin instance id.

localHost - local host name.

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.

ManagementException

createOrUpdateRemoteHostAddress

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

Creates or updates the connection details for the remote host to which the specified plug-in instance connects. A remote host address is required to establish a connection.

Scope: Cluster

Parameters:

pluginInstanceId - plugin instance id.

remoteHost - remote host name.

remotePort - remote host number.

Throws:

ManagementException.

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.

Scope: Cluster

Parameters:

credentialId - - Unique identifier for the credential in the configuration.

remoteUser - Value of the attribute 'user'.

remotePassword - Value of the attribute 'password'.

Throws:

ManagementException.

ManagementException

getAllListenAddress

public Set getAllListenAddress(String protocol)
                        throws ManagementException

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

Scope: Cluster

Parameters:

protocol - Name of the protocol, like UCP or SMPP.

Returns:

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

Throws:

ManagementException.

ManagementException

getConnectInfo

public ConnectInfo getConnectInfo(String pluginInstanceId)
                           throws ManagementException

Returns the ConnectInfo of the remote host (SMSC / network node) for the server on which this MBean resides. 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.

Scope: Cluster

Parameters:

pluginInstanceId - plugin instance id.

Returns:

the ConnectInfo of the remote host.

Throws:

ManagementException.

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.

Scope: Cluster

Parameters:

protocol - Name of the protocol, like UCP or SMPP.

Returns:

list of ServerAddress.

Throws:

ManagementException.

ManagementException

isValidationEnabled

public boolean isValidationEnabled()

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

Scope: Cluster

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.

Scope: Cluster

Returns:

Map containing all the credentialId to Credential mappings.

Throws:

ManagementException.

ManagementException

removeConnectInfo

public void removeConnectInfo(String pluginInstanceId)
                       throws ManagementException

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

Scope: Cluster

Parameters:

pluginInstanceId - plugin instance id.

Throws:

ManagementException.

ManagementException

removeCredentialEntry

public void removeCredentialEntry(String credentialId)
                           throws ManagementException

Removes the specified credential entry from the configuration.

Scope: Cluster

Parameters:

credentialId - - Unique identifier for the credential in the configuration.

Throws:

ManagementException.

ManagementException

removeCredentialMap

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

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

Scope: Cluster

Parameters:

pluginInstanceId - plugin instance id.

appId - application id.

Throws:

ManagementException.

ManagementException

removeListenAddress

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

Removes this listen address configuration from all the targets.

Scope: Cluster

Parameters:

protocol - Name of the protocol, like UCP or SMPP.

host - host name.

port - port number.

Throws:

ManagementException.

ManagementException

removeLocalHostAddress

public void removeLocalHostAddress(String pluginInstanceId)
                            throws ManagementException

Removes the local host address info associated with this pluginInstanceId.

Scope: Cluster

Parameters:

pluginInstanceId - plugin instance id.

Throws:

ManagementException.

ManagementException

removeXParamFromCredentialEntry

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

Removes the extra parameter associated with the given credentialId.

Scope: Cluster

Parameters:

credentialId - credential id.

xParamName - parameter name.

Returns:

Credential associated with the credentialId.

Throws:

ManagementException.

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.

Scope: Cluster

Parameters:

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

Skip navigation links