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

Interface SharedEndpointManagement

public interface SharedEndpointManagement

Management of the single, shared, internal Unity endpoint, which is not under administrator's control. It is intended for a cross-cutting functionality, where Unity has to listen for some requests but on an path which is not endpoint specific (e.g. for SAML responses, where return address must be the same for all authenticators).

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method and Description
void	deployInternalEndpointFilter(String contextPath, org.eclipse.jetty.servlet.FilterHolder filter) Deploys the given filter in the internal, shared endpoint.
void	deployInternalEndpointServlet(String contextPath, org.eclipse.jetty.servlet.ServletHolder servlet, boolean mapVaadinResource) Deploys the given servlet in the internal, shared endpoint.
String	getBaseContextPath()
String	getServerAddress()
String	getServletUrl(String servletPath)

Method Detail

deployInternalEndpointServlet

void deployInternalEndpointServlet(String contextPath,
                                   org.eclipse.jetty.servlet.ServletHolder servlet,
                                   boolean mapVaadinResource)
                            throws pl.edu.icm.unity.exceptions.EngineException

Deploys the given servlet in the internal, shared endpoint.

Parameters:

contextPath - path to the deployed servlet, will be the next element after the common context of the whole internal endpoint.

servlet - the servlet to deploy

Throws:

pl.edu.icm.unity.exceptions.EngineException

getBaseContextPath

String getBaseContextPath()

Returns:

the first element of the servlet's path, with a leading '/' and no trailing '/'.

getServletUrl

String getServletUrl(String servletPath)

Parameters:

servletPath - last path element of the servlet, without context prefix.

Returns:

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

deployInternalEndpointFilter

void deployInternalEndpointFilter(String contextPath,
                                  org.eclipse.jetty.servlet.FilterHolder filter)
                           throws pl.edu.icm.unity.exceptions.EngineException

Deploys the given filter in the internal, shared endpoint.

Parameters:

contextPath -

filter -

Throws:

pl.edu.icm.unity.exceptions.EngineException

getServerAddress

String getServerAddress()

Returns:

advertised address of the server