Skip navigation links

oracle.webservices.management
Interface InterceptorConfig

All Superinterfaces:

oracle.fabric.common.legacy.LegacyInterceptorConfigProvider

public interface InterceptorConfig

extends oracle.fabric.common.legacy.LegacyInterceptorConfigProvider

Implementations of this class represent a management interceptor configuration.

Field Summary

Fields inherited from interface oracle.fabric.common.legacy.LegacyInterceptorConfigProvider

PROPERTY_LEGACY_INTERCEPTOR_CONFIG_PROVIDER

Method Summary

void	addConfigListener(InterceptorConfigListener listener) Register a listener for configuration-related events.
void	clear() Clear the current configuration.
Document	getDocument() Get a Document describing the configuration.
Element	getGlobalConfig(String interceptorName) Get the global configuration for the specified interceptor.
Element	getOperationConfig(String interceptorName, OperationId operationId) Get the operation-level configuration for the specified interceptor.
String[]	getPipeline(PortId portId) Get the interceptor pipeline configuration.
Element	getPortConfig(String interceptorName, PortId portId) Get the port-level configuration for the specified interceptor.
boolean	isDirty() Determine whether the configuration has changed.
void	load() Load the configuration from its source.
void	removeApplication(String applicationName) Remove the application with the specified name from the interceptor configuration.
void	removeConfigListener(InterceptorConfigListener listener) Unregister the specified listener so it will no longer be notified of configuration-related events.
void	removePort(PortId portId) Remove the specified port from the interceptor configuration.
Element	setGlobalConfig(String interceptorName, Element configElement, boolean isDefault) Set the global configuration for the specified interceptor.
Element	setOperationConfig(String interceptorName, OperationId operationId, Element configElement, boolean isDefault) Set the operation-level configuration for the specified interceptor.
void	setPipeline(PortId portId, String[] interceptorNames, boolean isDefault) Configure the interceptor pipeline.
Element	setPortConfig(String interceptorName, PortId portId, Element configElement, boolean isDefault) Set the port-level configuration for the specified interceptor.
void	store() Store the current configuration.

Methods inherited from interface oracle.fabric.common.legacy.LegacyInterceptorConfigProvider

getInterceptorLegacyGlobalConfigElement, getInterceptorLegacyOperationConfigElements, getInterceptorLegacyPortConfigElement, isLegacyInterceptorEnabled

Method Detail

addConfigListener

void addConfigListener(InterceptorConfigListener listener)

Register a listener for configuration-related events.

Parameters:

listener - A InterceptorCOnfigListener instance.

removeConfigListener

void removeConfigListener(InterceptorConfigListener listener)

Unregister the specified listener so it will no longer be notified of configuration-related events.

Parameters:

listener - A InterceptorCOnfigListener instance.

clear

void clear()
           throws ConfigException

Clear the current configuration.

Throws:

ConfigException

load

void load()
          throws ConfigException

Load the configuration from its source.

Throws:

ConfigException

store

void store()
           throws ConfigException

Store the current configuration.

Throws:

ConfigException

getDocument

Document getDocument()

Get a Document describing the configuration.

Returns:

A Document instance.

removeApplication

void removeApplication(String applicationName)

Remove the application with the specified name from the interceptor configuration.

Parameters:

applicationName - The name of the application to remove.

removePort

void removePort(PortId portId)

Remove the specified port from the interceptor configuration.

Parameters:

portId - A PortId instance that uniquely identifies the port to remove.

isDirty

boolean isDirty()

Determine whether the configuration has changed.

Returns:

true if the configuration has changed; false otherwise.

getGlobalConfig

Element getGlobalConfig(String interceptorName)

Get the global configuration for the specified interceptor.

Parameters:

interceptorName - The name of an interceptor.

Returns:

An Element describing the global configuration.

setGlobalConfig

Element setGlobalConfig(String interceptorName,
                        Element configElement,
                        boolean isDefault)

Set the global configuration for the specified interceptor.

Parameters:

interceptorName - The name of the interceptor.

configElement - The configuration for the interceptor.

isDefault - Flag indicating whether or not the configuration represents the default configuration.

Returns:

An Element describing the global configuration.

getPortConfig

Element getPortConfig(String interceptorName,
                      PortId portId)

Get the port-level configuration for the specified interceptor.

Parameters:

interceptorName - The name of the interceptor.

portId - A PortId instance that uniquely identifies a port.

Returns:

An Element describing the port configuration.

setPortConfig

Element setPortConfig(String interceptorName,
                      PortId portId,
                      Element configElement,
                      boolean isDefault)

Set the port-level configuration for the specified interceptor.

Parameters:

interceptorName - The name of the interceptor.

portId - A PortId instance that uniquely identifies the port.

configElement - The configuration element for the interceptor.

isDefault - Flag indicating whether or not the configuration represents the default configuration.

Returns:

An Element describing the port configuration.

getPipeline

String[] getPipeline(PortId portId)

Get the interceptor pipeline configuration.

Parameters:

portId - A PortId instance that uniquely identifies the port.

Returns:

An array containing the name of those interceptors that are configured in the pipeline for the specified port.

setPipeline

void setPipeline(PortId portId,
                 String[] interceptorNames,
                 boolean isDefault)

Configure the interceptor pipeline.

Parameters:

portId - A PortId instance that uniquely identifies the port.

interceptorNames - An array of interceptor names that should be included in the pipeline.

isDefault - Flag indicating whether or not the configuration represents the default configuration.

getOperationConfig

Element getOperationConfig(String interceptorName,
                           OperationId operationId)

Get the operation-level configuration for the specified interceptor.

Parameters:

interceptorName - The name of the interceptor.

operationId - An OperationId instance that uniquely identifies the operation.

Returns:

An Element describing the operation configuration.

setOperationConfig

Element setOperationConfig(String interceptorName,
                           OperationId operationId,
                           Element configElement,
                           boolean isDefault)

Set the operation-level configuration for the specified interceptor.

Parameters:

interceptorName - The name of the interceptor.

operationId - An OperationId instance that uniquely identifies the operation.

configElement - The configuration element for the interceptor.

isDefault - Flag indicating whether or not the configuration represents the default configuration.

Returns:

An Element describing the operation configuration.

Skip navigation links