| Oracle® Communications Services Gatekeeper System Administrator's Guide Release 5.0 Part Number E16623-02 |
|
|
View PDF |
| Oracle® Communications Services Gatekeeper System Administrator's Guide Release 5.0 Part Number E16623-02 |
|
|
View PDF |
This chapter describes how tocreate and store connection and credential mappings in the Services Gatekeeper Connection Information Manager. The Connection Information Manager is used by the native UCP plug-ins.
The Connection Information Manager creates and stores connection and credential mappings that some plug-in instances need to connect to network elements and applications.
The connection information is stored in a ConnectInfo object.
The ConnectInfo object:
Stores the remote address to which the plug-in connects
Stores a map of application instance IDs (for example for Services Gatekeeper users) to network node credentials; there could be more than one set of credentials for a single network node
See Operation: getConnectInfo for details about the ConnectInfo object.
All configuration and management is performed in the ConnectionInfoManager managed object.
This object is accessible from the Administrative Console and from the Platform Test Environment (PTE).
The Administration Console displays one instance of the MBean for each plug-in instance that uses it. The management attributes for the Connection Information Manager are reached from the service:
Plugin_sms_ucp > ConnectInfoManager
The Connection Information Manager Operations, Administration, and Maintenance functionality is shared among the plug-ins. Rendering, however, is per plug-in (one instance is displayed per plug-in). The appearance may vary depending on how the MBean is accessed.
If you are using different plug-ins that use the Connection Information Manager, you need to configure the Connection Information Manager for each plug-in.
Use the following operations to configure and manage the connection information:
Use the following operations to configure and manage the credential map:
Use the following operations to configure and manage the listen information:
Managed object: ConnectInfoManager
MBean: oracle.ocsg.plugin.connection.management.ConnectInfoManagerMBean
Following is a list of attributes and operations for configuration:
Scope: Cluster
Unit: Not applicable
Format: Boolean
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 operations.
See Operation: createOrUpdateListenAddress and Operation: createOrUpdateLocalHostAddress.
The default is true.
Scope: Cluster
Adds additional parameter values to the credential map associated with the credentialId.
Use this operation to add any name-value pair to the operation. For example, native UCP can use this operation to provide connection-specific windowing and heartbeat parameters.
Signature:
addXParamToCredentialEntry(credentialId: String, xParamName: String, xParamValue: String)
Table 23-1 addXParamToCredentialEntry
| Parameter | Description |
|---|---|
|
credentialId |
Unique identifier for the credential in the configuration; created by a previous call to "Operation: createOrUpdateCredentialMap". |
|
xParamName |
User-defined name for the parameter |
|
xParamValue |
Value of the parameter |
Scope: Cluster
Creates a new entry or updates an existing entry in the credential map associated with the pluginInstanceId.
This operation 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.
Signature:
createOrUpdateCredentialMap(pluginInstanceId: String, appId: String, credentialId: String)
Table 23-2 createOrUpdateCredentialMap
| Parameter | Description |
|---|---|
|
pluginInstanceId |
ID of the plug-in instance being mapped; information about plug-in instances is maintained in the plug-in manager; see Operation:listPluginInstances in the Services Gatekeeper System Administrator's Guide for information about getting the list of plug-in instances IDs |
|
appId |
Application instance ID or Services Gatekeeper user to map to the remote host associated with the |
|
credentialId |
ID of an existing credential entry in the configuration. If this value is empty or null, any existing mapping for the |
Scope: Cluster
Adds a listen address or updates an existing entry. If updating, the target list is updated to the new targets value passed by this call.
Signature:
createOrUpdateListenAddress(protocol: String, host: String, port: int, targets: String)
Scope: Cluster
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.
Signature:
createOrUpdateLocalHostAddress(pluginInstanceId: String, localHost: String, localPort: int, targets: String)
Table 23-4 createOrUpdateLocalHostAddress
| Parameter | Description |
|---|---|
|
pluginInstanceId |
ID of the plug-in instance being mapped. See Operation:listPluginInstances in the System Administrator's Guide for information about getting the list of plug-in instance IDs. |
|
localHost |
Local host name or IP address |
|
localPort |
Local port number to bind to |
|
targets |
Comma-separated list of server names or cluster names; defaults to all the targets in the cluster |
Scope: Cluster
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.
Signature:
createOrUpdateRemoteHostAddress(pluginInstanceId: String, remoteHost: String, remotePort: int)
Table 23-5 createOrUpdateRemoteHostAddress
| Parameter | Description |
|---|---|
|
pluginInstanceId |
ID of the plug-in instance being mapped. See Operation:listPluginInstances in the System Administrator's Guide for information about getting the list of plug-in instance IDs. |
|
remoteHost |
Remote host name or IP address |
|
remotePort |
Remote port number to bind to |
Scope: Cluster
Creates or updates the user and password parameters associated with the credentialId.
Signature:
createOrUpdateUserPasswordCredentialEntry(credentialId: String, remoteUser: String, remotePassword: String)
Scope: Cluster
Returns the list of server addresses configured for this domain for the specified protocol.
Signature:
getAllListenAddress(protocol: String)
Scope: Server
Returns the ConnectInfo object of the remote host (SMSC or network node) for the server on which this MBean instance resides.
The ConnectInfo object includes:
remoteHost
remotePort
localHost
localPort
credentialMap
The localHost and localPort values are server-specific.
The credentialMap maps application identifier with network node credentials; for example, with an SMSC credential.
Signature:
getConnectInfo(pluginInstanceId: String)
Scope: Server
Returns a list of server addresses configured for the current server and the specified protocol.
Signature:
getListenAddressForCurrentServer(protocol: String)
Scope: Cluster
Returns the credential map containing the credential IDs and associated Credential objects in the configuration.
Signature:
listAllCredentialEntries()
Scope: Cluster
Removes the remote host's connect address, local connect address, and credential mapping for the plug-in referenced by the pluginInstanceId.
Signature:
removeConnectInfo(pluginInstanceId: String)
Scope: Cluster
Removes the specified credential entry from the configuration.
Signature:
removeCredentialEntry(credentialId: String)
Scope: Cluster
Removes the credential mapping between the appId and pluginInstanceId from the connect info configuration of the plug-in instance identified by the pluginInstanceId.
Signature:
removeCredentialMap(pluginInstanceId: String, appId: String)
Scope: Cluster
Removes the specified listen address configuration from all the targets.
Signature:
removeListenAddress(protocol: String, host: String, port:int)
Scope: Cluster
Removes the local host address information associated with the pluginInstanceId.
Signature:
removeLocalHostAddress(pluginInstanceId: String)
|
 Copyright © 2007, 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
