org.systinet.wasp.webservice
Interface Handlers

public interface Handlers

*

Handlers interface represents the chain of the jax-rpc handlers either for the service endpoint or for the client.

Since:

4.6

Component:

Core

Method Summary

WaspHandlerInfo	get(int position) Retrieves configuration of handler on given position.
int	insert(Handler handler) Inserts given handler instance at the end of handler chain of given processing.
int	insert(Handler handler, int position) Inserts given handler instance on the specified position of handler chain of given processing.
int	insert(Handler handler, QName[] understands) Inserts given handler instance at the end of handler chain of given processing.
int	insert(Handler handler, QName[] understands, int position) Inserts given handler instance on the specified position of handler chain of given processing.
int	insert(WaspHandlerInfo handlerInfo) Inserts handler customized by given handlerInfo at the end of chain of given processing.
int	insert(WaspHandlerInfo handlerInfo, int position) Inserts handler customized by given handlerInfo on the specified position of chain of given processing.
boolean	remove(int position) Removes handler from the handler chain found on given position.
boolean	remove(WaspHandlerInfo handlerInfo) Removes handler from the handler chain of given processing.
int	size() Retrieves number of handlers in the handler chain of given processing.

Method Detail

insert

public int insert(Handler handler)

Inserts given handler instance at the end of handler chain of given processing.

Parameters:

handler - handler instance

Returns:

position of handler in the chain

insert

public int insert(Handler handler,
                  int position)
           throws java.lang.IndexOutOfBoundsException

Inserts given handler instance on the specified position of handler chain of given processing.

Parameters:

handler - handler instance

position - position handler should be inserted on

Returns:

position of handler in the chain

Throws:

java.lang.IndexOutOfBoundsException - if position is if out of range (position < 0 || position > size())

insert

public int insert(Handler handler,
                  QName[] understands)

Inserts given handler instance at the end of handler chain of given processing.

Parameters:

handler - handler instance

Returns:

position of handler in the chain

insert

public int insert(Handler handler,
                  QName[] understands,
                  int position)
           throws java.lang.IndexOutOfBoundsException

Inserts given handler instance on the specified position of handler chain of given processing.

Parameters:

handler - handler instance

position - position handler should be inserted on

Returns:

position of handler in the chain

Throws:

java.lang.IndexOutOfBoundsException - if position is if out of range (position < 0 || position > size())

insert

public int insert(WaspHandlerInfo handlerInfo)

Inserts handler customized by given handlerInfo at the end of chain of given processing. Instantiation of handler is taking place during first invocation.

Parameters:

handlerInfo - handler configuration

Returns:

position of handler in the chain

insert

public int insert(WaspHandlerInfo handlerInfo,
                  int position)
           throws java.lang.IndexOutOfBoundsException

Inserts handler customized by given handlerInfo on the specified position of chain of given processing. Instantiation of handler is taking place during first invocation.

Parameters:

handlerInfo - handler configuration

position - position handler should be inserted on

Returns:

position of handler in the chain

Throws:

java.lang.IndexOutOfBoundsException - if position is if out of range (position < 0 || position > size())

remove

public boolean remove(WaspHandlerInfo handlerInfo)

Removes handler from the handler chain of given processing.

Parameters:

handlerInfo - handler to

Returns:

result of removing, true means success, false otherwise

remove

public boolean remove(int position)
               throws java.lang.IndexOutOfBoundsException

Removes handler from the handler chain found on given position.

Parameters:

position -

Returns:

result of removing, true means success, false otherwise

Throws:

java.lang.IndexOutOfBoundsException - if position is if out of range (position < 0 || position > size())

size

public int size()

Retrieves number of handlers in the handler chain of given processing.

Returns:

number of handlers

get

public WaspHandlerInfo get(int position)
                    throws java.lang.IndexOutOfBoundsException

Retrieves configuration of handler on given position.

Parameters:

position - position of handler

Returns:

handler configuration

Throws:

java.lang.IndexOutOfBoundsException - if position is if out of range (position < 0 || position > size())