org.fabric3.spi.host

Interface ServletHost

public interface ServletHost

Interface implemented by host environments that allow Servlets to be registered. This interface allows an SCA system service to register a servlet to handle inbound requests.

Method Summary

Modifier and Type	Method and Description
java.net.URL	getBaseHttpsUrl() Returns the base HTTP url of the servlet container.
java.net.URL	getBaseHttpUrl() Returns the base HTTP url of the servlet container.
default java.lang.String	getContextPath() Returns the servlet context path this host is registered under in the runtime.
java.lang.String	getHostType() Returns the servlet host type, typically the container name.
int	getHttpPort() Returns the runtime HTTP.
int	getHttpsPort() Returns the runtime HTTPS port.
boolean	isHttpsEnabled() True if HTTPS is enabled.
boolean	isMappingRegistered(java.lang.String mapping) Check to see if a mapping exists.
void	registerMapping(java.lang.String mapping, javax.servlet.Servlet servlet) Register a mapping for an instance of a Servlet.
javax.servlet.Servlet	unregisterMapping(java.lang.String mapping) Unregister a servlet mapping.

Method Detail

getHostType

java.lang.String getHostType()

Returns the servlet host type, typically the container name.

Returns:

the servlet host type

getHttpPort

int getHttpPort()

Returns the runtime HTTP.

Returns:

the runtime HTTP

getHttpsPort

int getHttpsPort()

Returns the runtime HTTPS port.

Returns:

the runtime HTTPS port

getBaseHttpUrl

java.net.URL getBaseHttpUrl()

Returns the base HTTP url of the servlet container.

Returns:

the base HTTP url of the servlet container.

getBaseHttpsUrl

java.net.URL getBaseHttpsUrl()

Returns the base HTTP url of the servlet container.

Returns:

the base HTTP url of the servlet container.

isHttpsEnabled

boolean isHttpsEnabled()

True if HTTPS is enabled.

Returns:

true if HTTPS is enabled

registerMapping

void registerMapping(java.lang.String mapping,
                     javax.servlet.Servlet servlet)

Register a mapping for an instance of a Servlet. This requests that the servlet container direct all requests to the designated mapping to the supplied Servlet instance.

Parameters:

mapping - the uri-mapping for the Servlet

servlet - the Servlet that should be invoked

unregisterMapping

javax.servlet.Servlet unregisterMapping(java.lang.String mapping)

Unregister a servlet mapping. This directs the servlet contain not to direct any more requests to a previously registered Servlet.

Parameters:

mapping - the uri-mapping for the Servlet

Returns:

the servlet that was registered to the mapping, null if nothing was registered to the mapping

isMappingRegistered

boolean isMappingRegistered(java.lang.String mapping)

Check to see if a mapping exists.

Parameters:

mapping - the uri-mapping for the Servlet

Returns:

true if mapping is registered, false otherwise

getContextPath

default java.lang.String getContextPath()

Returns the servlet context path this host is registered under in the runtime.

Returns:

the path