org.idoox.wasp.config
Interface WASPConfiguration

Deprecated. See new Runtime Publishing API (Processing)

public interface WASPConfiguration

This interface represents WSO2 SOA Enablement Server's central runtime registry of interceptors, header processors, encoding handlers, protocol handlers and serializations. Via an implementation of this interface one can also access the configurations of particular client stubs or service endpoints.

Since:

4.0

Component:

Core

Method Summary

ClientStubConfiguration	getDefaultClientConfiguration() Deprecated. This method provides access to the default configuration for client stubs outside any service (on the client).
ClientStubConfiguration	getDefaultClientConfiguration(WSContext service) Deprecated. This method provides access to the default configuration for client stubs inside a service.
ServiceEndpointConfiguration	getEndpointConfiguration(WSContext endpoint) Deprecated. This method provides access to the configuration of a service endpoint.
ClientStubConfiguration	getStubConfiguration(java.lang.Object stub) Deprecated. This method provides access to the configuration of a client stub.
ClientStubConfiguration	getStubConfiguration(java.lang.Object stub, java.lang.Class iface) Deprecated. This method provides access to the configuration of a client stub.
java.lang.String	registerDeserializer(Deserializer instance, QName type) Deprecated. Register a deserializer for an XML Schema type.
void	registerEndpointCreationListener(org.idoox.wasp.config.EndpointCreationListener listener) Deprecated. Registers listener which will be called whenever WSO2 SOA Enablement Server runtime creates a new service endpoint.
java.lang.String	registerFaultDeserializer(Deserializer instance, QName faultCode, java.lang.String faultActor, QName firstDetailElement) Deprecated. Register a fault deserializer for incoming faults.
java.lang.String	registerFaultSerializer(Serializer instance, java.lang.Class[] exceptions) Deprecated. Register a fault serializer for exceptions thrown by application.
java.lang.String	registerHeaderProcessor(HeaderProcessor instance) Deprecated. Register a header processor.
java.lang.String	registerInterceptor(Interceptor instance) Deprecated. Register an interceptor instance.
java.lang.String	registerProtocol(java.lang.String protocol, java.lang.Class protocolHandlerClass) Deprecated. Register a protocol handler.
java.lang.String	registerSerializer(Serializer instance, QName type) Deprecated. Register a serializer for an XML Schema type.
void	setDefaultProtocol(java.lang.String name) Deprecated. Sets the default protocol handler's name.
void	unregisterDeserializer(java.lang.String name) Deprecated. Unregister a deserializer.
void	unregisterFaultDeserializer(java.lang.String name) Deprecated. Unregister a fault deserializer.
void	unregisterFaultSerializer(java.lang.String name) Deprecated. Unregister a fault serializer.
void	unregisterHeaderProcessor(java.lang.String name) Deprecated. Unregister a header processor.
void	unregisterInterceptor(java.lang.String name) Deprecated. Unregister an interceptor.
void	unregisterProtocol(java.lang.String name) Deprecated. Unregister a protocol handler.
void	unregisterSerializer(java.lang.String name) Deprecated. Unregister a serializer.

Method Detail

registerInterceptor

public java.lang.String registerInterceptor(Interceptor instance)

Deprecated.

Register an interceptor instance.

Returns:

a name for the registered interceptor, the name is to be used when using the interceptor and when unregistering it.

unregisterInterceptor

public void unregisterInterceptor(java.lang.String name)

Deprecated.

Unregister an interceptor.

Throws:

java.lang.IllegalArgumentException - when no such interceptor exists.

registerHeaderProcessor

public java.lang.String registerHeaderProcessor(HeaderProcessor instance)

Deprecated.

Register a header processor.

Parameters:

instance - the instance of the newly registered header processor

Returns:

a name for the registered header processor, the name is to be used when using the header processor and when unregistering it.

unregisterHeaderProcessor

public void unregisterHeaderProcessor(java.lang.String name)

Deprecated.

Unregister a header processor.

Throws:

java.lang.IllegalArgumentException - when no such header processor exists.

registerProtocol

public java.lang.String registerProtocol(java.lang.String protocol,
                                         java.lang.Class protocolHandlerClass)

Deprecated.

Register a protocol handler. This is for different versions of XML protocols.

Parameters:

protocol - an identifier of the XML Protocol which this handler handles. This string must uniquely identify the XML Protocol.

protocolHandlerClass - the class of the protocol handler

Returns:

a name for the registered protocol handler, the name is to be used when using the protocol handler and when unregistering it. This name is equal to the given protocol name.

Throws:

java.lang.IllegalArgumentException - when a protocol handler is already registered for the given protocol.

unregisterProtocol

public void unregisterProtocol(java.lang.String name)

Deprecated.

Unregister a protocol handler.

Throws:

java.lang.IllegalArgumentException - when no such protocol handler exists.

setDefaultProtocol

public void setDefaultProtocol(java.lang.String name)

Deprecated.

Sets the default protocol handler's name.

Throws:

java.lang.IllegalArgumentException - when no such protocol handler exists.

registerSerializer

public java.lang.String registerSerializer(Serializer instance,
                                           QName type)

Deprecated.

Register a serializer for an XML Schema type.

Parameters:

instance - the serializer instance to be registered

type - the qname of the XML Schema type this serializer handles

Returns:

a name for the registered serializer, the name is to be used when using the serializer and when unregistering it.

unregisterSerializer

public void unregisterSerializer(java.lang.String name)

Deprecated.

Unregister a serializer.

Throws:

java.lang.IllegalArgumentException - when no such serializer exists.

registerDeserializer

public java.lang.String registerDeserializer(Deserializer instance,
                                             QName type)

Deprecated.

Register a deserializer for an XML Schema type.

Parameters:

instance - the deserializer instance to be registered

type - the qname of the XML Schema type this deserializer handles

Returns:

a name for the registered deserializer, the name is to be used when using the deserializer and when unregistering it.

unregisterDeserializer

public void unregisterDeserializer(java.lang.String name)

Deprecated.

Unregister a deserializer.

Throws:

java.lang.IllegalArgumentException - when no such deserializer exists.

registerFaultSerializer

public java.lang.String registerFaultSerializer(Serializer instance,
                                                java.lang.Class[] exceptions)

Deprecated.

Register a fault serializer for exceptions thrown by application.

Parameters:

instance - the serializer instance to be registered

exceptions - an array of exception classes which this serializer serializes

Returns:

a name for the registered serializer, the name is to be used when using the serializer and when unregistering it.

unregisterFaultSerializer

public void unregisterFaultSerializer(java.lang.String name)

Deprecated.

Unregister a fault serializer.

Throws:

java.lang.IllegalArgumentException - when no such serializer exists.

registerFaultDeserializer

public java.lang.String registerFaultDeserializer(Deserializer instance,
                                                  QName faultCode,
                                                  java.lang.String faultActor,
                                                  QName firstDetailElement)

Deprecated.

Register a fault deserializer for incoming faults.

Parameters:

instance - the deserializer instance to be registered

faultCode - the qname of the fault code of the incoming fault (if null, matches any)

faultActor - the actor URI present in the fault (if null, matches any)

firstDetailElement - the qname of the first element child of fault detail (if null, matches any)

Returns:

a name for the registered deserializer, the name is to be used when using the deserializer and when unregistering it.

unregisterFaultDeserializer

public void unregisterFaultDeserializer(java.lang.String name)

Deprecated.

Unregister a fault deserializer.

Throws:

java.lang.IllegalArgumentException - when no such deserializer exists.

getEndpointConfiguration

public ServiceEndpointConfiguration getEndpointConfiguration(WSContext endpoint)

Deprecated.

This method provides access to the configuration of a service endpoint.

getStubConfiguration

public ClientStubConfiguration getStubConfiguration(java.lang.Object stub,
                                                    java.lang.Class iface)

Deprecated.

This method provides access to the configuration of a client stub.

Parameters:

stub - the client stub object

iface - the interface of the client stub for which the configuration should be returned.

Returns:

the ClientStubConfiguration instance for configuration of this stub

Throws:

java.lang.IllegalArgumentException - when the object is not recognized as a client stub.

getStubConfiguration

public ClientStubConfiguration getStubConfiguration(java.lang.Object stub)

Deprecated.

This method provides access to the configuration of a client stub. This method can unexpectedly throw an IllegalArgumentException - that's in cases where the stub actually represents multiple ports of a service and therefore has multiple configs. Use getStubConfiguration(Object, Class) instead then.

Parameters:

stub - the client stub object

Returns:

the ClientStubConfiguration instance for configuration of this stub

Throws:

java.lang.IllegalArgumentException - when the stub has more than one interface or when the object is not recognized as a client stub.

getDefaultClientConfiguration

public ClientStubConfiguration getDefaultClientConfiguration()

Deprecated.

This method provides access to the default configuration for client stubs outside any service (on the client). This is used when a client stub is created and no configuration matches it.

Returns:

the ClientStubConfiguration instance for default configuration of new stubs

getDefaultClientConfiguration

public ClientStubConfiguration getDefaultClientConfiguration(WSContext service)

Deprecated.

This method provides access to the default configuration for client stubs inside a service. This is used when a client stub is created inside the service and no configuration matches it.

Parameters:

service - the service whose default stub configuration is to be returned (if null, the default client-side configuration is returned)

Returns:

the ClientStubConfiguration instance for default configuration of new stubs

registerEndpointCreationListener

public void registerEndpointCreationListener(org.idoox.wasp.config.EndpointCreationListener listener)

Deprecated.

Registers listener which will be called whenever WSO2 SOA Enablement Server runtime creates a new service endpoint.

This listener can for example associate some configuration related data with the newly created service endpoint.

Parameters:

listener - instance of ServiceCreationListener interface to be called when new service endpoint is created