org.jboss.wsf.spi.deployment

Interface Service

All Superinterfaces:

Extensible

public interface Service
extends Extensible

A service collecting endpoints belonging to the same deployment.

Since:

20-Apr-2007

Author:

Thomas.Diesler@jboss.com, alessio.soldano@jboss.com

Method Summary

Methods

Modifier and Type	Method and Description
void	addEndpoint(Endpoint endpoint) Add an endpoint to the service
String	getContextRoot() Get the context root for this service
Deployment	getDeployment() Get the deployment this service belongs to
Endpoint	getEndpointByName(String simpleName) Get an endpoint by name
List<Endpoint>	getEndpoints() Get the list of endpoints
List<Endpoint>	getEndpoints(EndpointTypeFilter filter) Get the list of endpoints
String	getVirtualHost() Get the virtual host for this service
boolean	removeEndpoint(Endpoint endpoint) Remove an endpoint from the service, returns true if successfull
void	setContextRoot(String contextRoot) Set the context root for this service
void	setVirtualHost(String virtualHost) Set the virtual host for this service

Methods inherited from interface org.jboss.wsf.spi.deployment.Extensible

addAttachment, getAttachment, getAttachments, getProperties, getProperty, removeAttachment, removeProperty, setProperties, setProperty

Method Detail

getDeployment

Deployment getDeployment()

Get the deployment this service belongs to

Returns:

the deployment this service belongs to

addEndpoint

void addEndpoint(Endpoint endpoint)

Add an endpoint to the service

Parameters:

endpoint - the endpoint to be added

removeEndpoint

boolean removeEndpoint(Endpoint endpoint)

Remove an endpoint from the service, returns true if successfull

Parameters:

endpoint - the endpoint to remove

Returns:

true if the endpoint was actually removed, false otherwise

getEndpoints

List<Endpoint> getEndpoints()

Get the list of endpoints

Returns:

a copy of the list of endpoints

getEndpoints

List<Endpoint> getEndpoints(EndpointTypeFilter filter)

Get the list of endpoints

Parameters:

filter - a filter for selecting endpoints

Returns:

a list of selected endpoints

getEndpointByName

Endpoint getEndpointByName(String simpleName)

Get an endpoint by name

Parameters:

simpleName - the name of the endpoint to get

Returns:

the selected endpoint

getContextRoot

String getContextRoot()

Get the context root for this service

Returns:

the context root for this service

setContextRoot

void setContextRoot(String contextRoot)

Set the context root for this service

Parameters:

contextRoot - the context root for this service

getVirtualHost

String getVirtualHost()

Get the virtual host for this service

Returns:

the virtual host for this service

setVirtualHost

void setVirtualHost(String virtualHost)

Set the virtual host for this service

Parameters:

virtualHost - the virtual host for this service