com.bea.wlcp.wlng.plugin
Interface PluginManagerMBean

public interface PluginManagerMBean

Plug-in manager MBean

Field Summary

static boolean	forceConnectInResuming True indicates that the plug-in will not start if it fails to establish communication toward the network in a protocol specific way.
static boolean	policyBasedRouting Defines if policy-based routing is enabled.
static boolean	supportBulkRequest Set to true to enable bulk request support.

Method Summary

abstract void	addRoute(java.lang.String pluginInstanceId, java.lang.String addressExpression) Deprecated. Use setRouteConfig
abstract void	createPluginInstance(java.lang.String pluginServiceId, java.lang.String pluginInstanceId) Creates a new instance of a specific plug-in.
abstract void	destroyPluginInstance(java.lang.String pluginServiceId, java.lang.String pluginInstanceId) Destroys an existing plug-in instance.
abstract boolean	getForceConnectInResuming() Returns true if the plug-in will not start if it fails to establish communication toward the network in a protocol specific way, false otherwise.
abstract PluginInstanceInfo	getPluginInstanceInfo(java.lang.String pluginInstanceId) Gets information about a particular plug-in instance.
abstract java.lang.String	getPluginNodeId(java.lang.String pluginInstanceId) Returns which plug-in node ID a plug-in instance is associated with, if any.
abstract PluginServiceInfo	getPluginServiceInfo(java.lang.String pluginServiceId) Gets info for a specific plug-in service.
abstract boolean	getPolicyBasedRouting() Returns true if policy-based routing is enabled.
abstract java.lang.String	getRouteConfig(java.lang.String pluginInstanceId) Gets the route configuration for a specific plug-in instance.
abstract com.bea.wlcp.wlng.api.plugin.ServiceInfo	getServiceInfo(java.lang.String type) Returns the service information for a given service type.
abstract boolean	getSupportBulkRequest() Returns true bulk requests are supported.
abstract boolean	getSupportGroupAddressRequest()
abstract java.util.Map	listInterceptors(java.lang.String ip) Returns a list of all enabled interceptors in Services Gatekeeper.
abstract java.lang.String[]	listPluginInstances() Lists all available plugin instances. Example: Plug-in instance ID#JEE application name#version of JEE application The plug-in instance ID is the part of each entry up to the first #.
abstract java.lang.String[]	listPluginServices() Lists plug-in service IDs.
abstract PluginRouteDesc[]	listRoutes() Lists all configured routes.
abstract java.lang.String[]	listServiceTypes() Lists all the available service types.
abstract void	removeRoute(java.lang.String pluginInstanceId, java.lang.String addressExpression) Deprecated. Use setRouteConfig
abstract java.lang.String	retrieveInterceptorConfiguration() Returns the active interceptor rule configuration in Services Gatekeeper.
abstract void	setForceConnectInResuming(boolean force) If set to true, a network protocol plug-in service is allowed to transition to state ACTIVE if it fails to establish a connection with the underlying network node during deployment or re-deployment.
abstract void	setPluginNodeId(java.lang.String pluginInstanceId, java.lang.String nodeId) Assigns a node ID to a plug-in.
abstract void	setPolicyBasedRouting(boolean policyBasedRoutingFlag) If true, policy based routing is used, if false, policy-based routing is disabled.
abstract void	setRouteConfig(java.lang.String pluginInstanceId, java.lang.String fileContent) Sets the route configuration for a specific plug-in instance.
abstract void	setRouteConfigFromUrl(java.lang.String pluginInstanceId, java.lang.String xmlConfigUrl) Sets the route configuration for a specific plug-in instance.
abstract void	setSupportBulkRequest(boolean supportBulkRequest) If set to true, SMS requests with multiple recipients are split into multiple individually-addressed SMS requests.
abstract void	setSupportGroupAddressRequest(boolean supportGroupAddressRequest) Scope: Cluster
abstract void	updateInterceptorConfiguration(java.lang.String fileContent) Updates the Services Gatekeeper interceptor rule configuration.

Field Detail

forceConnectInResuming

public static final boolean forceConnectInResuming

True indicates that the plug-in will not start if it fails to establish communication toward the network in a protocol specific way. Every plug-in in a given .ear must be active, otherwise the .ear would fail to transition to ACTIVE state This allows activating a new version of the plug-in only when it is certain that it could accept traffic.

Scope: Cluster

See Also:

Constant Field Values

policyBasedRouting

public static final boolean policyBasedRouting

Defines if policy-based routing is enabled. This flag determines if node SLAs should be considered in the plug-in selection.

Scope: Cluster

See Also:

Constant Field Values

supportBulkRequest

public static final boolean supportBulkRequest

Set to true to enable bulk request support. If true, send one request for each address in bulk request.

Scope: Cluster

See Also:

Constant Field Values

Method Detail

addRoute

public void addRoute(java.lang.String pluginInstanceId,
                     java.lang.String addressExpression)
              throws com.bea.wlcp.wlng.api.management.ManagementException

Deprecated. Use setRouteConfig

Adds a route for a specific plug-in instance. Any application initiated request that includes a destination address will be routed according to these routes.

Scope: Cluster

Parameters:

pluginInstanceId - The id of the plug-in instance. Use listPluginInstanceIds operation to find all available instances.

addressExpression - Regular expression to match with the address. The expression is formated as "[scheme:]regexp". For example: ^[0-5].* - All adresses starting with 0, 1, 2, 3, 4 or 5 ^46.* - All adresses starting with "46" ^46.{8} - All adresses starting with "46" and being exactly 10 characters long ^.*@.*\.se - All adresses starting with anything followed by @ followed by anything and ending with ".se" tel:^46.* - All phone numbers starting with "46" sip:.* - Any SIP adresses

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

createPluginInstance

public void createPluginInstance(java.lang.String pluginServiceId,
                                 java.lang.String pluginInstanceId)
                          throws com.bea.wlcp.wlng.api.management.ManagementException

Creates a new instance of a specific plug-in.

Scope: Cluster

Parameters:

pluginServiceId - Plug-in service ID from listPluginServices().

pluginInstanceId - A new unique instance ID.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

destroyPluginInstance

public void destroyPluginInstance(java.lang.String pluginServiceId,
                                  java.lang.String pluginInstanceId)
                           throws com.bea.wlcp.wlng.api.management.ManagementException

Destroys an existing plug-in instance.

Scope: Cluster

Parameters:

pluginServiceId - Plug-in service ID from listPluginServices().

pluginInstanceId - The unique instance ID.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

getForceConnectInResuming

public boolean getForceConnectInResuming()
                                  throws com.bea.wlcp.wlng.api.management.ManagementException

Returns true if the plug-in will not start if it fails to establish communication toward the network in a protocol specific way, false otherwise. Every plug-in in a given .ear must be active, otherwise the .ear would fail to transition to ACTIVE state.

Scope: Cluster

Returns:

true if forced connection enabled, false if disabled

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

getPluginInstanceInfo

public PluginInstanceInfo getPluginInstanceInfo(java.lang.String pluginInstanceId)
                                         throws com.bea.wlcp.wlng.api.management.ManagementException

Gets information about a particular plug-in instance. During side-by-side deployment, returns the active plug-in version, when more than one is available. Information returned includes:

• The node ID, if the plug-in instance is assigned a node ID using setPluginNodeId.
• A list of application-facing interfaces registered with the plug-in manager.
• A list of network-facing interfaces registered with the plug-in manager.
• Whether the plug-in instance is connected to the network node (true if connected).
• A list of all configured routes.

Scope: Cluster

Parameters:

pluginInstanceId - ID of the plug-in instance

Returns:

Information regarding the plug-in instance. This includes nodeId, connected status and configured routes.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

getPluginNodeId

public java.lang.String getPluginNodeId(java.lang.String pluginInstanceId)

Returns which plug-in node ID a plug-in instance is associated with, if any.

Scope: Cluster

Parameters:

pluginInstanceId - The plug-in instance ID.

Returns:

The node ID.

getPluginServiceInfo

public PluginServiceInfo getPluginServiceInfo(java.lang.String pluginServiceId)
                                       throws com.bea.wlcp.wlng.api.management.ManagementException

Gets info for a specific plug-in service.

Scope: Cluster

Parameters:

pluginServiceId - ID of the plug-in.

Returns:

Information regarding the plug-in service. This includes service type, network protocol and active instances.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

getPolicyBasedRouting

public boolean getPolicyBasedRouting()

Returns true if policy-based routing is enabled. False otherwise.

Scope: Cluster

Returns:

true if policy-based routing enabled, false otherwise

getRouteConfig

public java.lang.String getRouteConfig(java.lang.String pluginInstanceId)
                                throws com.bea.wlcp.wlng.api.management.ManagementException

Gets the route configuration for a specific plug-in instance.

Scope: Cluster

Parameters:

pluginInstanceId - The ID of the plug-in instance.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

getServiceInfo

public com.bea.wlcp.wlng.api.plugin.ServiceInfo getServiceInfo(java.lang.String type)
                                                        throws com.bea.wlcp.wlng.api.management.ManagementException

Returns the service information for a given service type. The service information contains the interface names, method names for each interface, and arguments name for each method.

Scope: Cluster

Parameters:

type - The service type.

Returns:

Information about the service type.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

getSupportBulkRequest

public boolean getSupportBulkRequest()

Returns true bulk requests are supported. False otherwise.

Scope: Cluster

Returns:

true if bulk requests are supported, false otherwise

getSupportGroupAddressRequest

public boolean getSupportGroupAddressRequest()

listInterceptors

public java.util.Map listInterceptors(java.lang.String ip)

Returns a list of all enabled interceptors in Services Gatekeeper.

Scope: Domain

Parameters:

ip - name InterceptionPoint (MT_NORTH, MT_SOUTH, MO_NORTH or MO_SOUTH)

listPluginInstances

public java.lang.String[] listPluginInstances()

Lists all available plugin instances.
Example:
Plug-in instance ID#JEE application name#version of JEE application
The plug-in instance ID is the part of each entry up to the first #.

Scope: Cluster

Returns:

A list of plug-in instance IDs.

listPluginServices

public java.lang.String[] listPluginServices()

Lists plug-in service IDs. A plug-in service ID uniquely identifies a plug-in service.

Scope: Cluster

Returns:

A list of plug-in service IDs.

listRoutes

public PluginRouteDesc[] listRoutes()

Lists all configured routes.

Scope: Cluster

listServiceTypes

public java.lang.String[] listServiceTypes()

Lists all the available service types. The service type defines a collection of plug-in services exposing a specific functionality in the network, for example, SMS or MMS.

Scope: Cluster

Returns:

The service types available.

removeRoute

public void removeRoute(java.lang.String pluginInstanceId,
                        java.lang.String addressExpression)
                 throws com.bea.wlcp.wlng.api.management.ManagementException

Deprecated. Use setRouteConfig

Removes a configured route. Execute listRoutes and use the plug-in instance id together with the address pattern to remove it.

Scope: Cluster

Parameters:

pluginInstanceId - Plug-in instance id.

addressExpression - Address expression.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

retrieveInterceptorConfiguration

public java.lang.String retrieveInterceptorConfiguration()
                                                  throws com.bea.wlcp.wlng.api.management.ManagementException

Returns the active interceptor rule configuration in Services Gatekeeper.

Scope: Domain

Returns:

rule to custom interceptor chain.

Throws:

ManagementException.

com.bea.wlcp.wlng.api.management.ManagementException

setForceConnectInResuming

public void setForceConnectInResuming(boolean force)
                               throws com.bea.wlcp.wlng.api.management.ManagementException

If set to true, a network protocol plug-in service is allowed to transition to state ACTIVE if it fails to establish a connection with the underlying network node during deployment or re-deployment. This assures that a new version of the network protocol plug-in service is activated only when it is certain that it can accept traffic.

If enabled, all plug-in services packaged in the EAR that is being updated must become active before any traffic is routed to the plug-in instances derived from the new version. If any plug-in instance fails to connect to the underlying network, the new version does not become active.

Scope: Cluster

Parameters:

force - True indicates that every plug-in must be active

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

setPluginNodeId

public void setPluginNodeId(java.lang.String pluginInstanceId,
                            java.lang.String nodeId)
                     throws com.bea.wlcp.wlng.api.management.ManagementException

Assigns a node ID to a plug-in. The node id is used to identify groups of plug-ins in the node contracts.

Scope: Cluster

Parameters:

pluginInstanceId - Plug-in instance ID.

nodeId - Node ID. This ID is used when enforcing node SLAs.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

setPolicyBasedRouting

public void setPolicyBasedRouting(boolean policyBasedRoutingFlag)
                           throws com.bea.wlcp.wlng.api.management.ManagementException

If true, policy based routing is used, if false, policy-based routing is disabled.

Scope: Cluster

Parameters:

policyBasedRoutingFlag - Flag for enabling or disabling policy based routing.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

setRouteConfig

public void setRouteConfig(java.lang.String pluginInstanceId,
                           java.lang.String fileContent)
                    throws com.bea.wlcp.wlng.api.management.ManagementException

Sets the route configuration for a specific plug-in instance. Existing routing logic is overwritten,

Scope: Cluster

Parameters:

pluginInstanceId - The id of the plug-in instance. Use listPluginInstanceIds operation to find all available instances.

fileContent - XML document that describes the routing for this plug-in instance. If this field is empty the configuration will be removed.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

setRouteConfigFromUrl

public void setRouteConfigFromUrl(java.lang.String pluginInstanceId,
                                  java.lang.String xmlConfigUrl)
                           throws com.bea.wlcp.wlng.api.management.ManagementException

Sets the route configuration for a specific plug-in instance.

Scope: Cluster

Parameters:

pluginInstanceId - The id of the plug-in instance. Use listPluginInstanceIds operation to find all available instances.

xmlConfigUrl - URL to Xml document that describes the routing for this plug-in instance. If this field is empty the configuration will be removed.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

setSupportBulkRequest

public void setSupportBulkRequest(boolean supportBulkRequest)
                           throws com.bea.wlcp.wlng.api.management.ManagementException

If set to true, SMS requests with multiple recipients are split into multiple individually-addressed SMS requests. Customized message content for each address included in the submission is supported when supportBulkRequest is set to true and a DifferentContentForSingleAddressInBulk xparam, is also set to true and added to the request.

Scope: Cluster

Parameters:

supportBulkRequest - true if bulk requests enabled, false otherwise.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

setSupportGroupAddressRequest

public void setSupportGroupAddressRequest(boolean supportGroupAddressRequest)
                                   throws com.bea.wlcp.wlng.api.management.ManagementException

Scope: Cluster

Parameters:

supportGroupAddressRequest - Flag for enabling or disabling GroupAddress Request support.

Throws:

com.bea.wlcp.wlng.api.management.ManagementException

updateInterceptorConfiguration

public void updateInterceptorConfiguration(java.lang.String fileContent)
                                    throws com.bea.wlcp.wlng.api.management.ManagementException

Updates the Services Gatekeeper interceptor rule configuration.

Scope: Domain

Parameters:

fileContent - The contents in an interceptorRule.xml file.

Throws:

ManagementException.

com.bea.wlcp.wlng.api.management.ManagementException