org.jboss.remoting3
Interface Endpoint.ServiceBuilder<I,O>

Type Parameters:

I - the request type

O - the reply type

Enclosing interface:

Endpoint

public static interface Endpoint.ServiceBuilder<I,O>

A service builder for new service registration.

Method Summary

Registration	register() Register the service.
Endpoint.ServiceBuilder<I,O>	setClientListener(ClientListener<? super I,? extends O> clientListener) Set the request listener.
Endpoint.ServiceBuilder<I,O>	setGroupName(String groupName) Set the group name.
Endpoint.ServiceBuilder<I,O>	setOptionMap(org.jboss.xnio.OptionMap optionMap) Set the option map for the service.
<N> Endpoint.ServiceBuilder<I,N>	setReplyType(Class<N> newReplyType) Clear the configured client listener and set a new reply type.
<N> Endpoint.ServiceBuilder<N,O>	setRequestType(Class<N> newRequestType) Clear the configured client listener and set a new request type.
Endpoint.ServiceBuilder<I,O>	setServiceType(String serviceType) Set the service type string, which should follow the convention for package names (reversed domain names).

Method Detail

setGroupName

Endpoint.ServiceBuilder<I,O> setGroupName(String groupName)

Set the group name.

Parameters:

groupName - the group name

Returns:

this builder

setServiceType

Endpoint.ServiceBuilder<I,O> setServiceType(String serviceType)

Set the service type string, which should follow the convention for package names (reversed domain names).

Parameters:

serviceType - the service type

Returns:

this builder

setRequestType

<N> Endpoint.ServiceBuilder<N,O> setRequestType(Class<N> newRequestType)

Clear the configured client listener and set a new request type.

Type Parameters:

N - the new request type

Parameters:

newRequestType - the new request type's class

Returns:

this builder, cast to include the new request type

setReplyType

<N> Endpoint.ServiceBuilder<I,N> setReplyType(Class<N> newReplyType)

Clear the configured client listener and set a new reply type.

Type Parameters:

N - the new reply type

Parameters:

newReplyType - the new reply type's class

Returns:

this builder, cast to include the new reply type

setClientListener

Endpoint.ServiceBuilder<I,O> setClientListener(ClientListener<? super I,? extends O> clientListener)

Set the request listener. The given listener may be configured to accept a superclass of the given request type, or a subclass of the given reply type, since they are compatible.

Parameters:

clientListener - the request listener

Returns:

this builder

setOptionMap

Endpoint.ServiceBuilder<I,O> setOptionMap(org.jboss.xnio.OptionMap optionMap)

Set the option map for the service. The options may include, but are not limited to:

• RemotingOptions.BUFFER_SIZE - the recommended buffer size for marshallers to use for this service
• RemotingOptions.CLASS_COUNT - the recommended class count for marshallers to use for this service
• RemotingOptions.INSTANCE_COUNT - the recommended instance count for marshallers to use for this service
• RemotingOptions.METRIC - the relative desirability or "distance" of this service
• RemotingOptions.MARSHALLING_PROTOCOLS - the marshalling protocols which are allowed for this service, in order of decreasing preference; if none is given, all registered protocols will be made available
• RemotingOptions.MARSHALLING_CLASS_RESOLVERS - the class resolvers which are allowed for this service, in order of decreasing preference; if none is given, the default class resolver is used
• RemotingOptions.MARSHALLING_CLASS_TABLES - the class tables which are allowed for this service, in order of decreasing preference
• RemotingOptions.MARSHALLING_EXTERNALIZER_FACTORIES - the class externalizer factories which are allowed for this service, in order of decreasing preference
• RemotingOptions.REMOTELY_VISIBLE - true if this service should be remotely accessible, false otherwise (defaults to true)
• RemotingOptions.REQUIRE_SECURE - true if this service may only be accessed over a secure/encrypted channel; defaults to false, however this should be set to true if sensitive data (e.g. passwords) may be transmitted as part of a payload

Parameters:

optionMap - the option map

Returns:

this builder

register

Registration register()
                      throws IOException

Register the service.

You must have the registerService EndpointPermission to invoke this method.

Returns:

a registration handle

Throws:

IOException - if a problem occurs with registration