org.ops4j.pax.web.service.spi.config

Interface Configuration

public interface Configuration

Interface for accessing configuration that's normally available/provided using Configuration Admin properties or Meta Type information. If possible, server implementations should access Pax Web properties through methods of this interface, not through general property names in some dictionary.

Splitting original Configuration object into groups should help with future extensibility.

Actual server implementations should access entire configuration using this interface without a need to create extra org.ops4j.util.property.PropertyResolver instances.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	all() Low level access to all String properties with String values.
<T> T	get(String property, Class<T> clazz) Accesses single typed property by name.
String	id() Get unique identifier of the configuration.
JspConfiguration	jsp() Accesses JSP related configuration used for Tomcat/Jasper engine configuration
LogConfiguration	logging() Accesses configuration related to server logging and access logging.
ResourceConfiguration	resources() Accesses configuration related to "resource handling" (default servlets per resource definition).
SecurityConfiguration	security() Accesses security related configuration for SSL/TLS, certificates and authentication.
ServerConfiguration	server() Accesses server-wide configuration that covers listeners, directory locations, ports, etc.
SessionConfiguration	session() Accesses session related configuration

Method Detail

id

String id()

Get unique identifier of the configuration. Because ServerControllerFactory may create more server controllers, but only for different configurations.

Returns:

server

ServerConfiguration server()

Accesses server-wide configuration that covers listeners, directory locations, ports, etc.

Returns:

security

SecurityConfiguration security()

Accesses security related configuration for SSL/TLS, certificates and authentication.

Returns:

resources

ResourceConfiguration resources()

Accesses configuration related to "resource handling" (default servlets per resource definition).

Returns:

jsp

JspConfiguration jsp()

Accesses JSP related configuration used for Tomcat/Jasper engine configuration

Returns:

session

SessionConfiguration session()

Accesses session related configuration

Returns:

logging

LogConfiguration logging()

Accesses configuration related to server logging and access logging.

Returns:

get

<T> T get(String property,
          Class<T> clazz)

Accesses single typed property by name.

Parameters:

property -

Returns:

all

Map<String,String> all()

Low level access to all String properties with String values. Useful when passing to server-specific configuration mechanisms.

Returns: