Package 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	Description
protected AdvertisedAddressProvider	advertisedAddrProvider
protected NetworkServer	httpServer

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

authenticationFlows, description, properties

Constructor Summary

Constructors

Constructor	Description
AbstractWebEndpoint(NetworkServer httpServer, AdvertisedAddressProvider advertisedAddrProvider)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Stops the endpoint.
protected void	destroyOverridable()
java.net.URL	getBaseUrl()
java.lang.String	getServletUrl(java.lang.String servletPath)
void	start()	Starts the endpoint.
protected void	startOverridable()

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

getAuthenticationFlows, 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.EndpointInstance

getAuthenticationFlows, getEndpointDescription, getSerializedConfiguration, initialize, updateAuthenticationFlows

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

getServletContextHandler

Field Detail

httpServer

protected final NetworkServer httpServer

advertisedAddrProvider

protected final AdvertisedAddressProvider advertisedAddrProvider

Constructor Detail

AbstractWebEndpoint

public AbstractWebEndpoint(NetworkServer httpServer,
                           AdvertisedAddressProvider advertisedAddrProvider)

Method Detail

getBaseUrl

public java.net.URL getBaseUrl()

Returns:

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

getServletUrl

public java.lang.String getServletUrl(java.lang.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 final 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

startOverridable

protected void startOverridable()

destroy

public final 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

destroyOverridable

protected void destroyOverridable()