com.cisco.oss.foundation.http.server.jetty

Enum JettyHttpServerFactory

java.lang.Object

java.lang.Enum<JettyHttpServerFactory>

com.cisco.oss.foundation.http.server.jetty.JettyHttpServerFactory

All Implemented Interfaces:

com.cisco.oss.foundation.http.server.HttpServerFactory, JettyHttpServerFactoryExtensions, Serializable, Comparable<JettyHttpServerFactory>

public enum JettyHttpServerFactory
extends Enum<JettyHttpServerFactory>
implements com.cisco.oss.foundation.http.server.HttpServerFactory, JettyHttpServerFactoryExtensions

This is a factory that enables creating servers in a common way. Refer to the wiki to see the full configuration set possible.

Author:

Yair Ogen

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE implementing singleton using enum

Field Summary

Fields inherited from interface com.cisco.oss.foundation.http.server.HttpServerFactory

FLOW_CONTEXT_HEADER, X_FORWARD_FOR_HEADER

Method Summary

Methods

Modifier and Type	Method and Description
void	setErrorHandler(String serviceName, org.eclipse.jetty.server.handler.ErrorHandler errorHandler)
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets) start a new http server
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, List<EventListener> eventListeners)
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters) start a new http server
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters, List<EventListener> eventListeners)
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filterMap, List<EventListener> eventListeners, Map<String,String> initParams)
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters, List<EventListener> eventListeners, Map<String,String> initParams, String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword)
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters, List<EventListener> eventListeners, String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword)
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters, String keyStorePath, String keyStorePassword) start a new http server
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters, String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword) start a new http server
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, Map<String,String> initParams)
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, String keyStorePath, String keyStorePassword) start a new http server
void	startHttpServer(String serviceName, com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets, String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword) start a new http server
void	stopHttpServer(String serviceName) stop the http server
static JettyHttpServerFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static JettyHttpServerFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final JettyHttpServerFactory INSTANCE

implementing singleton using enum

Method Detail

values

public static JettyHttpServerFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JettyHttpServerFactory c : JettyHttpServerFactory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JettyHttpServerFactory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets)

start a new http server

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

Parameters:

serviceName - - the http logical service name

servlets - - a mapping between servlet path and servlet instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Servlet> servletMap = ArrayListMultimap.create()

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   Map<String,String> initParams)

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filterMap,
                   List<EventListener> eventListeners,
                   Map<String,String> initParams)

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   List<EventListener> eventListeners)

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters)

start a new http server

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

Parameters:

serviceName - - the http logical service name

servlets - - a mapping between servlet path and servlet instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Servlet> servletMap = ArrayListMultimap.create()

filters - - a mapping between filter path and filter instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Filter> filterMap = ArrayListMultimap.create()

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters,
                   List<EventListener> eventListeners)

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters,
                   String keyStorePath,
                   String keyStorePassword)

start a new http server

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

Parameters:

serviceName - - the http logical service name

servlets - - a mapping between servlet path and servlet instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Servlet> servletMap = ArrayListMultimap.create()

filters - - a mapping between filter path and filter instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Filter> filterMap = ArrayListMultimap.create()

keyStorePath - - a path to the keystore file

keyStorePassword - - the keystore password

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   String keyStorePath,
                   String keyStorePassword)

start a new http server

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

Parameters:

serviceName - - the http logical service name

servlets - - a mapping between servlet path and servlet instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Servlet> servletMap = ArrayListMultimap.create()

keyStorePath - - a path to the keystore file

keyStorePassword - - the keystore password

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters,
                   String keyStorePath,
                   String keyStorePassword,
                   String trustStorePath,
                   String trustStorePassword)

start a new http server

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

Parameters:

serviceName - - the http logical service name

servlets - - a mapping between servlet path and servlet instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Servlet> servletMap = ArrayListMultimap.create()

filters - - a mapping between filter path and filter instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Filter> filterMap = ArrayListMultimap.create()

keyStorePath - - a path to the keystore file

keyStorePassword - - the keystore password

trustStorePath - - the trust store file path

trustStorePassword - - the trust store password

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters,
                   List<EventListener> eventListeners,
                   String keyStorePath,
                   String keyStorePassword,
                   String trustStorePath,
                   String trustStorePassword)

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Filter> filters,
                   List<EventListener> eventListeners,
                   Map<String,String> initParams,
                   String keyStorePath,
                   String keyStorePassword,
                   String trustStorePath,
                   String trustStorePassword)

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

startHttpServer

public void startHttpServer(String serviceName,
                   com.google.common.collect.ListMultimap<String,javax.servlet.Servlet> servlets,
                   String keyStorePath,
                   String keyStorePassword,
                   String trustStorePath,
                   String trustStorePassword)

start a new http server

Specified by:

startHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

Parameters:

serviceName - - the http logical service name

servlets - - a mapping between servlet path and servlet instance. This mapping uses the google collections ListMultimap.
Example of usage: ArrayListMultimap<String,Servlet> servletMap = ArrayListMultimap.create()

keyStorePath - - a path to the keystore file

keyStorePassword - - the keystore password

trustStorePath - - the trust store file path

trustStorePassword - - the trust store password

stopHttpServer

public void stopHttpServer(String serviceName)

stop the http server

Specified by:

stopHttpServer in interface com.cisco.oss.foundation.http.server.HttpServerFactory

Parameters:

serviceName - - the http logical service name

setErrorHandler

public void setErrorHandler(String serviceName,
                   org.eclipse.jetty.server.handler.ErrorHandler errorHandler)

Specified by:

setErrorHandler in interface JettyHttpServerFactoryExtensions