Skip navigation links

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

int	customMatch(RequestInfo requestInfo) Checks if the plug-in can be used given the provided request info.
List	getNorthInterfaces() Returns all north interfaces.
List	getSouthInterfaces() Returns all south interfaces.
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 its considered as 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 List getNorthInterfaces()

Returns all north interfaces.

Returns:

The north interfaces

getSouthInterfaces

public List getSouthInterfaces()

Returns all south interfaces.

Returns:

The south 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

Skip navigation links