Interface HttpInterfaceCommonPolicy
-
public interface HttpInterfaceCommonPolicy
Policy information for the HTTP management interface that is common across both standalone and domain mode.- Author:
- Darran Lofthouse
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
HttpInterfaceCommonPolicy.Header
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<String>
getAllowedOrigins()
Get the list of origins that the server should accept requests from, if none set then all forms of cross origin resource sharing are disabled.org.xnio.OptionMap
getConnectorOptions()
Get the connector options based on the current configuration.Map<String,List<HttpInterfaceCommonPolicy.Header>>
getConstantHeaders()
A set of HTTP headers that should be set on each response based on matching the key of the map as being a prefix of the requested path.String
getHttpAuthenticationFactory()
Get the name of the HTTP authentication factory to use to secure the interface for normal HTTP requests.String
getSaslAuthenticationFactory()
Get the name of the SASL authentication factory to use to secure the interface where HTTP upgrade is used.String
getSSLContext()
Get the name of the SSLContext to use to enable SSL for this management interface.boolean
isConsoleEnabled()
Is the management console enabled, is set tofalse
the console should not be made available.boolean
isHttpUpgradeEnabled()
Is upgrading to a Remoting connection over the HTTP interface enabled.
-
-
-
Method Detail
-
getHttpAuthenticationFactory
String getHttpAuthenticationFactory()
Get the name of the HTTP authentication factory to use to secure the interface for normal HTTP requests.- Returns:
- The name of the SASL authentication factory to use to secure the interface for normal HTTP requests.
-
getSSLContext
String getSSLContext()
Get the name of the SSLContext to use to enable SSL for this management interface.- Returns:
- the name of the SSLContext to use to enable SSL for this management interface.
-
getSaslAuthenticationFactory
String getSaslAuthenticationFactory()
Get the name of the SASL authentication factory to use to secure the interface where HTTP upgrade is used.- Returns:
- The name of the SASL authentication factory to use to secure the interface where HTTP upgrade is used.
-
isConsoleEnabled
boolean isConsoleEnabled()
Is the management console enabled, is set tofalse
the console should not be made available.- Returns:
true
if the management console should be made available,false
otherwise.
-
isHttpUpgradeEnabled
boolean isHttpUpgradeEnabled()
Is upgrading to a Remoting connection over the HTTP interface enabled.- Returns:
true
if HTTP Upgrade to the native protocol is enabled,false
otherwise.
-
getConnectorOptions
org.xnio.OptionMap getConnectorOptions()
Get the connector options based on the current configuration.- Returns:
- the connector options based on the current configuration.
-
getAllowedOrigins
List<String> getAllowedOrigins()
Get the list of origins that the server should accept requests from, if none set then all forms of cross origin resource sharing are disabled. An emptyList
ornull
both signal that cross origin resource sharing should be disabled.- Returns:
- The list of origins that the server should accept requests from.
-
getConstantHeaders
Map<String,List<HttpInterfaceCommonPolicy.Header>> getConstantHeaders()
A set of HTTP headers that should be set on each response based on matching the key of the map as being a prefix of the requested path. A prefix is inclusive of an exact match.- Returns:
- A
Map
of the constant headers to be set on each response with the key being used as the prefix.
-
-