Package org.jboss.as.server.mgmt.domain

Interface ExtensibleHttpManagement

All Superinterfaces:

HttpManagement

public interface ExtensibleHttpManagement
extends HttpManagement

API via which subsystems can extend the HTTP management interface functionality by adding specific types of new contexts.

Author:

Brian Stansberry

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExtensibleHttpManagement.PathRemapper	Converts a context relative path to a path appropriate for use with the /management context.

Method Summary

Modifier and Type	Method	Description
void	addManagementGetRemapContext(String contextName, ExtensibleHttpManagement.PathRemapper remapper)	Add a context that remaps GET request paths to paths appropriate to the normal /management context and then dispatches the request to the normal handling for the /management context.
void	addManagementHandler(String contextName, boolean requiresSecurity, io.undertow.server.HttpHandler managementHandler)	Add a context for a HTTP management handler.
void	addStaticContext(String contextName, io.undertow.server.handlers.resource.ResourceManager resourceManager)	Add a context that serves static resources
void	removeContext(String contextName)	Remove a previously added context

Methods inherited from interface org.jboss.as.server.mgmt.domain.HttpManagement

getHttpNetworkInterfaceBinding, getHttpPort, getHttpsNetworkInterfaceBinding, getHttpsPort, hasConsole

Method Details

addStaticContext

void addStaticContext(String contextName,
 io.undertow.server.handlers.resource.ResourceManager resourceManager)

Add a context that serves static resources

Parameters:

contextName - the name of the context. Cannot be null or empty

resourceManager - manager to provide resources for the context. Cannot be null

Throws:

IllegalArgumentException - if either parameter is invalid

IllegalStateException - if there is already a context present named the same as contextName, either added via this interface or otherwise

addManagementGetRemapContext

void addManagementGetRemapContext(String contextName,
 ExtensibleHttpManagement.PathRemapper remapper)

Add a context that remaps GET request paths to paths appropriate to the normal /management context and then dispatches the request to the normal handling for the /management context. POST requests result in a 405.

Parameters:

contextName - the name of the context. Cannot be null or empty

remapper - object that converts request paths

Throws:

IllegalArgumentException - if either parameter is invalid

IllegalStateException - if there is already a context present named the same as contextName, either added via this interface or otherwise

addManagementHandler

void addManagementHandler(String contextName,
 boolean requiresSecurity,
 io.undertow.server.HttpHandler managementHandler)

Add a context for a HTTP management handler.

Parameters:

contextName - the name of the context. Cannot be null or empty

requiresSecurity - true if the management handler requires a security realm.

managementHandler - HTTP management handler. Cannot be null

Throws:

IllegalArgumentException - if either parameter is invalid

IllegalStateException - if there is already a context present named the same as contextName, either added via this interface or otherwise

removeContext

void removeContext(String contextName)

Remove a previously added context

Parameters:

contextName - the name of the context. Cannot be null or empty

Throws:

IllegalArgumentException - if contextName is null or empty

IllegalStateException - if no context present named contextName was added via this interface