com.bea.wlcp.wlng.api.plugin
Interface PluginInstance

All Known Subinterfaces:

ManagedPluginInstance

All Known Implementing Classes:

ManagedPlugin

public interface PluginInstance

Defines a plug-in instance. Implemented by a plug-in so that it can register with the plug-in manager.

Field Summary

static int	MATCH_OPTIONAL Constant used by customMatch() to indicate that the plugin is optional.
static int	MATCH_REMOVE Constant used by customMatch() to indicate that the plugin should not be used.
static int	MATCH_REQUIRED Constant used by customMatch() to indicate that the plugin is required.

Method Summary

abstract int	customMatch(RequestInfo requestInfo) Checks if the plug-in can be used given the provided request info.
abstract java.util.List	getNorthInterfaces() Returns all application facing interfaces.
abstract java.util.List	getSouthInterfaces() Returns all network facing interfaces.
abstract boolean	isConnected() Checks if the plug-in is connected to the underlying network.

Field Detail

MATCH_OPTIONAL

public static final int MATCH_OPTIONAL

Constant used by customMatch() to indicate that the plugin is optional.

See Also:

Constant Field Values

MATCH_REMOVE

public static final int MATCH_REMOVE

Constant used by customMatch() to indicate that the plugin should not be used.

See Also:

Constant Field Values

MATCH_REQUIRED

public static final int MATCH_REQUIRED

Constant used by customMatch() to indicate that the plugin is required.

See Also:

Constant Field Values

Method Detail

customMatch

public int customMatch(RequestInfo requestInfo)

Checks if the plug-in can be used given the provided request info. The return value indicates if the plug-in should be removed, and whether it is considered optional or required.

Parameters:

requestInfo - The request info.

Returns:

Value indicating if the plug-in should be removed, is required or considered optional. Use the MATCH_xxx constants only.

getNorthInterfaces

public java.util.List getNorthInterfaces()

Returns all application facing interfaces.

Returns:

The application facing interfaces.

getSouthInterfaces

public java.util.List getSouthInterfaces()

Returns all network facing interfaces.

Returns:

The network facing interfaces.

isConnected

public boolean isConnected()

Checks if the plug-in is connected to the underlying network. That is, whether it is ready to receive traffic.

Returns:

True if the plug-in is connected.