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
ResolvedEndpoint	deploy(String typeId, String endpointName, String address, EndpointConfiguration configuration)	Deploys a new instance of an endpoint of id type, at address location.
List<ResolvedEndpoint>	getDeployedEndpoints()
Endpoint	getEndpoint(String name)
List<Endpoint>	getEndpoints()
List<EndpointTypeDescription>	getEndpointTypes()
void	removeEndpoint(String id)	Removes endpoint with given name
void	undeploy(String id)	Removes a deployed endpoint
void	updateEndpoint(String id, EndpointConfiguration configuration)	Updates a deployed endpoint configuration

Method Detail

getEndpointTypes

List<EndpointTypeDescription> getEndpointTypes()
                                        throws EngineException

Returns:

available endpoint types

Throws:

EngineException

getDeployedEndpoints

List<ResolvedEndpoint> getDeployedEndpoints()
                                     throws EngineException

Returns:

list of deployed endpoints

Throws:

EngineException

deploy

ResolvedEndpoint deploy(String typeId,
                        String endpointName,
                        String address,
                        EndpointConfiguration configuration)
                 throws 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:

EngineException

undeploy

void undeploy(String id)
       throws EngineException

Removes a deployed endpoint

Parameters:

id - endpoint instance id.

Throws:

EngineException

updateEndpoint

void updateEndpoint(String id,
                    EndpointConfiguration configuration)
             throws 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:

EngineException

getEndpoints

List<Endpoint> getEndpoints()
                     throws AuthorizationException

Returns:

all endpoints from db

Throws:

AuthorizationException

removeEndpoint

void removeEndpoint(String id)
             throws EngineException

Removes endpoint with given name

Parameters:

id - mandatory id of removed endpoint

Throws:

EngineException

getEndpoint

Endpoint getEndpoint(String name)
              throws AuthorizationException

Parameters:

name - endpoint name

Returns:

Throws:

AuthorizationException