Package pl.edu.icm.unity.engine.api

Interface EndpointManagement

public interface EndpointManagement

Management of endpoints

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method	Description
pl.edu.icm.unity.types.endpoint.ResolvedEndpoint	deploy(String typeId, String endpointName, String address, pl.edu.icm.unity.types.endpoint.EndpointConfiguration configuration)	Deploys a new instance of an endpoint of id type, at address location.
List<pl.edu.icm.unity.types.endpoint.ResolvedEndpoint>	getDeployedEndpoints()
pl.edu.icm.unity.types.endpoint.Endpoint	getEndpoint(String name)
List<pl.edu.icm.unity.types.endpoint.Endpoint>	getEndpoints()
List<pl.edu.icm.unity.types.endpoint.EndpointTypeDescription>	getEndpointTypes()
void	removeEndpoint(String id)	Removes endpoint with given name
void	undeploy(String id)	Removes a deployed endpoint
void	updateEndpoint(String id, pl.edu.icm.unity.types.endpoint.EndpointConfiguration configuration)	Updates a deployed endpoint configuration

Method Detail

getEndpointTypes

List<pl.edu.icm.unity.types.endpoint.EndpointTypeDescription> getEndpointTypes()
                                                                        throws pl.edu.icm.unity.exceptions.EngineException

Returns:

available endpoint types

Throws:

pl.edu.icm.unity.exceptions.EngineException

getDeployedEndpoints

List<pl.edu.icm.unity.types.endpoint.ResolvedEndpoint> getDeployedEndpoints()
                                                                     throws pl.edu.icm.unity.exceptions.EngineException

Returns:

list of deployed endpoints

Throws:

pl.edu.icm.unity.exceptions.EngineException

deploy

pl.edu.icm.unity.types.endpoint.ResolvedEndpoint deploy(String typeId,
                                                        String endpointName,
                                                        String address,
                                                        pl.edu.icm.unity.types.endpoint.EndpointConfiguration configuration)
                                                 throws pl.edu.icm.unity.exceptions.EngineException

Deploys a new instance of an endpoint of id type, at address location. Address is a path in web app context for the servlet endpoints.

Parameters:

typeId -

endpointName - identifier to be given to the endpoint

address -

configuration -

Throws:

pl.edu.icm.unity.exceptions.EngineException

undeploy

void undeploy(String id)
       throws pl.edu.icm.unity.exceptions.EngineException

Removes a deployed endpoint

Parameters:

id - endpoint instance id.

Throws:

pl.edu.icm.unity.exceptions.EngineException

updateEndpoint

void updateEndpoint(String id,
                    pl.edu.icm.unity.types.endpoint.EndpointConfiguration configuration)
             throws pl.edu.icm.unity.exceptions.EngineException

Updates a deployed endpoint configuration

Parameters:

id - mandatory id of a deployed endpoint

configuration - updated configuration, can have null elements to leave the existing values unchanged.

Throws:

pl.edu.icm.unity.exceptions.EngineException

getEndpoints

List<pl.edu.icm.unity.types.endpoint.Endpoint> getEndpoints()
                                                     throws pl.edu.icm.unity.exceptions.AuthorizationException

Returns:

all endpoints from db

Throws:

pl.edu.icm.unity.exceptions.AuthorizationException

removeEndpoint

void removeEndpoint(String id)
             throws pl.edu.icm.unity.exceptions.EngineException

Removes endpoint with given name

Parameters:

id - mandatory id of removed endpoint

Throws:

pl.edu.icm.unity.exceptions.EngineException

getEndpoint

pl.edu.icm.unity.types.endpoint.Endpoint getEndpoint(String name)
                                              throws pl.edu.icm.unity.exceptions.AuthorizationException

Parameters:

name - endpoint name

Returns:

Throws:

pl.edu.icm.unity.exceptions.AuthorizationException