org.apache.qpid.server.management.plugin

Class HttpManagement

java.lang.Object

org.apache.qpid.server.model.AbstractConfiguredObject<X>

org.apache.qpid.server.model.adapter.AbstractPluginAdapter<HttpManagement>

org.apache.qpid.server.management.plugin.HttpManagement

All Implemented Interfaces:

HttpManagementConfiguration<HttpManagement>, ConfiguredObject<HttpManagement>, ContextProvider, PermissionedObject, Plugin<HttpManagement>, PortManager, TaskExecutorProvider

public class HttpManagement
extends AbstractPluginAdapter<HttpManagement>
implements HttpManagementConfiguration<HttpManagement>, PortManager

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

AbstractConfiguredObject.CallableWithArgument<V,A>, AbstractConfiguredObject.ChainedListenableFuture<V>, AbstractConfiguredObject.ChainedSettableFuture<V>, AbstractConfiguredObject.DuplicateIdException, AbstractConfiguredObject.DuplicateNameException

Field Summary

Fields

Modifier and Type	Field and Description
boolean	_corsAllowCredentials
String	_corsAllowHeaders
Set<String>	_corsAllowMethods
String	_corsAllowOrigins
static String	DEFAULT_LOGIN_URL
static String	DEFAULT_LOGOUT_URL
static int	DEFAULT_TIMEOUT_IN_SECONDS
static String	HTTP_BASIC_AUTHENTICATION_ENABLED
static String	HTTP_SASL_AUTHENTICATION_ENABLED
static String	HTTPS_BASIC_AUTHENTICATION_ENABLED
static String	HTTPS_SASL_AUTHENTICATION_ENABLED
static String	PLUGIN_TYPE
static String	TIME_OUT

Fields inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

SECURED_STRING_VALUE

Fields inherited from interface org.apache.qpid.server.management.plugin.HttpManagementConfiguration

DEFAULT_COMPRESS_RESPONSES, DEFAULT_DISABLE_UI, DEFAULT_HTTP_MANAGEMENT_ENABLE_CONTENT_AUTHENTICATION, DEFAULT_MAX_UPLOAD_SIZE, DEFAULT_PREFERENCE_OPERATION_TIMEOUT, DEFAULT_SASL_EXCHANGE_EXPIRY, DISABLE_UI_CONTEXT_NAME, HTTP_MANAGEMENT_COMPRESS_RESPONSES, HTTP_MANAGEMENT_ENABLE_CONTENT_AUTHENTICATION, MAX_HTTP_FILE_UPLOAD_SIZE_CONTEXT_NAME, PREFERENCE_OPERTAION_TIMEOUT_CONTEXT_NAME, SASL_EXCHANGE_EXPIRY_CONTEXT_NAME

Fields inherited from interface org.apache.qpid.server.model.ConfiguredObject

AWAIT_ATTAINMENT_TIMEOUT, CONTEXT, CREATED_BY, CREATED_TIME, DEFAULT_AWAIT_ATTAINMENT_TIMEOUT, DESCRIPTION, DESIRED_STATE, DURABLE, ID, LAST_UPDATED_BY, LAST_UPDATED_TIME, LIFETIME_POLICY, NAME, OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT, STATE, TYPE

Constructor Summary

Constructors

Constructor and Description
HttpManagement(Map<String,Object> attributes, Broker broker)

Method Summary

Modifier and Type	Method and Description
static Set<String>	getAllAvailableCorsMethodCombinations()
AuthenticationProvider	getAuthenticationProvider(javax.servlet.http.HttpServletRequest request)
int	getBoundPort(HttpPort httpPort)
boolean	getCorsAllowCredentials()
String	getCorsAllowHeaders()
Set<String>	getCorsAllowMethods()
String	getCorsAllowOrigins()
int	getNumberOfAcceptors(HttpPort httpPort)
int	getNumberOfSelectors(HttpPort httpPort)
HttpPort<?>	getPort(javax.servlet.http.HttpServletRequest request)
long	getSaslExchangeExpiry()
int	getSessionTimeout()
SSLContext	getSSLContext(HttpPort httpPort)
boolean	isCompressResponses()
boolean	isHttpBasicAuthenticationEnabled()
boolean	isHttpSaslAuthenticationEnabled()
boolean	isHttpsBasicAuthenticationEnabled()
boolean	isHttpsSaslAuthenticationEnabled()
protected com.google.common.util.concurrent.ListenableFuture<Void>	onClose()
protected void	onOpen()
boolean	updateSSLContext(HttpPort httpPort)
protected void	validateChange(ConfiguredObject<?> proxyForValidation, Set<String> changedAttributes)

Methods inherited from class org.apache.qpid.server.model.adapter.AbstractPluginAdapter

getBroker, getChildren, onValidate

Methods inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

addChangeListener, addChildAsync, addFutureCallback, applyToChildren, asObjectRecord, attainState, attributeSet, authorise, authorise, authorise, authoriseCreateChild, awaitChildClassToAttainState, awaitChildClassToAttainState, beforeClose, beforeDelete, changeAttributes, childAdded, childRemoved, close, closeAsync, closeChildren, create, createAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, deleteChildren, deleteNoChecks, doAfter, doAfter, doAfter, doAfter, doAfter, doAfter, doAfterAlways, doAfterAlways, doCreation, doOnConfigThread, doOpening, doResolution, doSync, doSync, doValidation, findConfiguredObject, forceUpdateAllSecureAttributes, getAccessControl, getActualAttributes, getAncestor, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getContext, getContextKeys, getContextValue, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getStatistics, getSubjectWithAddedSystemRights, getSystemPrincipal, getSystemTaskControllerContext, getSystemTaskSubject, getSystemTaskSubject, getTaskExecutor, getType, getTypeClass, getUserPreferences, handleExceptionOnOpen, hasEncrypter, isDurable, isSystemProcess, isSystemSubject, logOperation, managesChildStorage, newToken, notifyStateChanged, onCreate, onDelete, onExceptionInOpen, onResolve, open, openAsync, postResolve, postResolveChildren, postSetAttributes, registerWithParents, removeChangeListener, removeContextVariable, rethrowRuntimeExceptionsOnOpen, runTask, setAttributes, setAttributesAsync, setContextVariable, setEncrypter, setState, setUserPreferences, start, startAsync, stop, toString, updateModel, validateChildDelete, validateOnCreate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.qpid.server.model.ConfiguredObject

addChangeListener, asObjectRecord, authorise, authorise, authorise, close, closeAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, findConfiguredObject, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getChildren, getContext, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getStatistics, getType, getTypeClass, getUserPreferences, hasEncrypter, isDurable, managesChildStorage, newToken, open, openAsync, removeChangeListener, removeContextVariable, setAttributes, setAttributesAsync, setContextVariable, setUserPreferences

Methods inherited from interface org.apache.qpid.server.model.ContextProvider

getContextKeys, getContextValue, getContextValue

Methods inherited from interface org.apache.qpid.server.model.TaskExecutorProvider

getTaskExecutor

Field Detail

DEFAULT_TIMEOUT_IN_SECONDS

public static final int DEFAULT_TIMEOUT_IN_SECONDS

See Also:

Constant Field Values

TIME_OUT

public static final String TIME_OUT

See Also:

Constant Field Values

HTTP_BASIC_AUTHENTICATION_ENABLED

public static final String HTTP_BASIC_AUTHENTICATION_ENABLED

See Also:

Constant Field Values

HTTPS_BASIC_AUTHENTICATION_ENABLED

public static final String HTTPS_BASIC_AUTHENTICATION_ENABLED

See Also:

Constant Field Values

HTTP_SASL_AUTHENTICATION_ENABLED

public static final String HTTP_SASL_AUTHENTICATION_ENABLED

See Also:

Constant Field Values

HTTPS_SASL_AUTHENTICATION_ENABLED

public static final String HTTPS_SASL_AUTHENTICATION_ENABLED

See Also:

Constant Field Values

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

Constant Field Values

DEFAULT_LOGOUT_URL

public static final String DEFAULT_LOGOUT_URL

See Also:

Constant Field Values

DEFAULT_LOGIN_URL

public static final String DEFAULT_LOGIN_URL

See Also:

Constant Field Values

_corsAllowOrigins

public String _corsAllowOrigins

_corsAllowMethods

public Set<String> _corsAllowMethods

_corsAllowHeaders

public String _corsAllowHeaders

_corsAllowCredentials

public boolean _corsAllowCredentials

Constructor Detail

HttpManagement

public HttpManagement(Map<String,Object> attributes,
                      Broker broker)

Method Detail

onOpen

protected void onOpen()

Overrides:

onOpen in class AbstractConfiguredObject<HttpManagement>

onClose

protected com.google.common.util.concurrent.ListenableFuture<Void> onClose()

Overrides:

onClose in class AbstractConfiguredObject<HttpManagement>

getSessionTimeout

public int getSessionTimeout()

Specified by:

getSessionTimeout in interface HttpManagementConfiguration<HttpManagement>

getCorsAllowOrigins

public String getCorsAllowOrigins()

Specified by:

getCorsAllowOrigins in interface HttpManagementConfiguration<HttpManagement>

getCorsAllowMethods

public Set<String> getCorsAllowMethods()

Specified by:

getCorsAllowMethods in interface HttpManagementConfiguration<HttpManagement>

getCorsAllowHeaders

public String getCorsAllowHeaders()

Specified by:

getCorsAllowHeaders in interface HttpManagementConfiguration<HttpManagement>

getCorsAllowCredentials

public boolean getCorsAllowCredentials()

Specified by:

getCorsAllowCredentials in interface HttpManagementConfiguration<HttpManagement>

getBoundPort

public int getBoundPort(HttpPort httpPort)

Specified by:

getBoundPort in interface PortManager

getNumberOfAcceptors

public int getNumberOfAcceptors(HttpPort httpPort)

Specified by:

getNumberOfAcceptors in interface PortManager

getNumberOfSelectors

public int getNumberOfSelectors(HttpPort httpPort)

Specified by:

getNumberOfSelectors in interface PortManager

getSSLContext

public SSLContext getSSLContext(HttpPort httpPort)

Specified by:

getSSLContext in interface PortManager

updateSSLContext

public boolean updateSSLContext(HttpPort httpPort)

Specified by:

updateSSLContext in interface PortManager

isHttpsSaslAuthenticationEnabled

public boolean isHttpsSaslAuthenticationEnabled()

Specified by:

isHttpsSaslAuthenticationEnabled in interface HttpManagementConfiguration<HttpManagement>

isHttpSaslAuthenticationEnabled

public boolean isHttpSaslAuthenticationEnabled()

Specified by:

isHttpSaslAuthenticationEnabled in interface HttpManagementConfiguration<HttpManagement>

isHttpsBasicAuthenticationEnabled

public boolean isHttpsBasicAuthenticationEnabled()

Specified by:

isHttpsBasicAuthenticationEnabled in interface HttpManagementConfiguration<HttpManagement>

isHttpBasicAuthenticationEnabled

public boolean isHttpBasicAuthenticationEnabled()

Specified by:

isHttpBasicAuthenticationEnabled in interface HttpManagementConfiguration<HttpManagement>

isCompressResponses

public boolean isCompressResponses()

Specified by:

isCompressResponses in interface HttpManagementConfiguration<HttpManagement>

getAuthenticationProvider

public AuthenticationProvider getAuthenticationProvider(javax.servlet.http.HttpServletRequest request)

Specified by:

getAuthenticationProvider in interface HttpManagementConfiguration<HttpManagement>

getAllAvailableCorsMethodCombinations

public static Set<String> getAllAvailableCorsMethodCombinations()

getPort

public HttpPort<?> getPort(javax.servlet.http.HttpServletRequest request)

Specified by:

getPort in interface HttpManagementConfiguration<HttpManagement>

validateChange

protected void validateChange(ConfiguredObject<?> proxyForValidation,
                              Set<String> changedAttributes)

Overrides:

validateChange in class AbstractConfiguredObject<HttpManagement>

getSaslExchangeExpiry

public long getSaslExchangeExpiry()

Specified by:

getSaslExchangeExpiry in interface HttpManagementConfiguration<HttpManagement>