pl.edu.icm.unity.engine.api.endpoint

Class AbstractWebEndpoint

java.lang.Object

pl.edu.icm.unity.engine.api.endpoint.AbstractEndpoint

pl.edu.icm.unity.engine.api.endpoint.AbstractWebEndpoint

All Implemented Interfaces:

EndpointInstance, WebAppEndpointInstance

public abstract class AbstractWebEndpoint
extends AbstractEndpoint
implements WebAppEndpointInstance

Typical boilerplate for all WebAppEndpointInstances.

Author:

K. Benedyczak

Field Summary

Fields

Modifier and Type	Field and Description
protected NetworkServer	httpServer

Fields inherited from class pl.edu.icm.unity.engine.api.endpoint.AbstractEndpoint

authenticators, description, properties

Constructor Summary

Constructors

Constructor and Description
AbstractWebEndpoint(NetworkServer httpServer)

Method Summary

Modifier and Type	Method and Description
void	destroy() Stops the endpoint.
URL	getBaseUrl()
String	getServletUrl(String servletPath)
void	start() Starts the endpoint.

Methods inherited from class pl.edu.icm.unity.engine.api.endpoint.AbstractEndpoint

getAuthenticationOptions, getEndpointDescription, getSerializedConfiguration, initialize, setAuthenticators, setSerializedConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface pl.edu.icm.unity.engine.api.endpoint.WebAppEndpointInstance

getServletContextHandler

Methods inherited from interface pl.edu.icm.unity.engine.api.endpoint.EndpointInstance

getAuthenticationOptions, getEndpointDescription, getSerializedConfiguration, initialize, updateAuthenticationOptions

Field Detail

httpServer

protected NetworkServer httpServer

Constructor Detail

AbstractWebEndpoint

public AbstractWebEndpoint(NetworkServer httpServer)

Method Detail

getBaseUrl

public URL getBaseUrl()

Returns:

the URL where the server listens to. It has no path element.

getServletUrl

public String getServletUrl(String servletPath)

Parameters:

servletPath - path of the servlet exposing the endpoint, Only the servlet's path, without context prefix.

Returns:

URL in string form, including the servers address, context address and the servlet's address.

start

public void start()
           throws pl.edu.icm.unity.exceptions.EngineException

Description copied from interface: EndpointInstance

Starts the endpoint. After this method returns the endpoint should be made available for usage.

Specified by:

start in interface EndpointInstance

Throws:

pl.edu.icm.unity.exceptions.EngineException

destroy

public void destroy()
             throws pl.edu.icm.unity.exceptions.EngineException

Description copied from interface: EndpointInstance

Stops the endpoint.

Specified by:

destroy in interface EndpointInstance

Overrides:

destroy in class AbstractEndpoint

Throws:

pl.edu.icm.unity.exceptions.EngineException