org.wildfly.swarm.config.management

Class HTTPInterfaceManagementInterface<T extends HTTPInterfaceManagementInterface<T>>

java.lang.Object

org.wildfly.swarm.config.management.HTTPInterfaceManagementInterface<T>

public class HTTPInterfaceManagementInterface<T extends HTTPInterfaceManagementInterface<T>>
extends Object

Configuration of the server's HTTP management interface

Constructor Summary

Constructors

Constructor and Description
HTTPInterfaceManagementInterface()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a property change listener
T	allowedOrigin(String value) Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.
List<String>	allowedOrigins() Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.
T	allowedOrigins(List<String> value) Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.
T	allowedOrigins(String... args) Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.
Boolean	consoleEnabled() Flag that indicates admin console is enabled
T	consoleEnabled(Boolean value) Flag that indicates admin console is enabled
String	getKey()
String	httpAuthenticationFactory() The authentication policy to use to secure the interface for normal HTTP requests.
T	httpAuthenticationFactory(String value) The authentication policy to use to secure the interface for normal HTTP requests.
Map	httpUpgrade() HTTP Upgrade specific configuration
T	httpUpgrade(Map value) HTTP Upgrade specific configuration
T	httpUpgrade(String key, Object value) HTTP Upgrade specific configuration
Boolean	httpUpgradeEnabled() Deprecated. Instead use http-upgrade.enabled
T	httpUpgradeEnabled(Boolean value) Deprecated. Instead use http-upgrade.enabled
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a property change listener
String	saslProtocol() Deprecated. Only for use with the legacy security realms.
T	saslProtocol(String value) Deprecated. Only for use with the legacy security realms.
String	secureSocketBinding() The name of the socket binding configuration to use for the HTTPS management interface's socket.
T	secureSocketBinding(String value) The name of the socket binding configuration to use for the HTTPS management interface's socket.
String	securityRealm() Deprecated. Configuration should migrate to reference 'http-authentication-factory', 'sasl-authentication-factory', and 'ssl-context' capabilities as required.
T	securityRealm(String value) Deprecated. Configuration should migrate to reference 'http-authentication-factory', 'sasl-authentication-factory', and 'ssl-context' capabilities as required.
String	serverName() Deprecated. Only for use with the legacy security realms.
T	serverName(String value) Deprecated. Only for use with the legacy security realms.
String	socketBinding() The name of the socket binding configuration to use for the HTTP management interface's socket.
T	socketBinding(String value) The name of the socket binding configuration to use for the HTTP management interface's socket.
String	sslContext() Reference to the SSLContext to use for this management interface.
T	sslContext(String value) Reference to the SSLContext to use for this management interface.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTTPInterfaceManagementInterface

public HTTPInterfaceManagementInterface()

Method Detail

getKey

public String getKey()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a property change listener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a property change listener

allowedOrigins

public List<String> allowedOrigins()

Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.

allowedOrigins

public T allowedOrigins(List<String> value)

Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.

allowedOrigin

public T allowedOrigin(String value)

Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.

allowedOrigins

public T allowedOrigins(String... args)

Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.

consoleEnabled

public Boolean consoleEnabled()

Flag that indicates admin console is enabled

consoleEnabled

public T consoleEnabled(Boolean value)

Flag that indicates admin console is enabled

httpAuthenticationFactory

public String httpAuthenticationFactory()

The authentication policy to use to secure the interface for normal HTTP requests.

httpAuthenticationFactory

public T httpAuthenticationFactory(String value)

The authentication policy to use to secure the interface for normal HTTP requests.

httpUpgrade

public Map httpUpgrade()

HTTP Upgrade specific configuration

httpUpgrade

public T httpUpgrade(Map value)

HTTP Upgrade specific configuration

httpUpgrade

public T httpUpgrade(String key,
                     Object value)

HTTP Upgrade specific configuration

httpUpgradeEnabled

@Deprecated
public Boolean httpUpgradeEnabled()

Deprecated. Instead use http-upgrade.enabled

Flag that indicates HTTP Upgrade is enabled, which allows HTTP requests to be upgraded to native remoting connections

httpUpgradeEnabled

@Deprecated
public T httpUpgradeEnabled(Boolean value)

Deprecated. Instead use http-upgrade.enabled

Flag that indicates HTTP Upgrade is enabled, which allows HTTP requests to be upgraded to native remoting connections

saslProtocol

@Deprecated
public String saslProtocol()

Deprecated. Only for use with the legacy security realms.

The name of the protocol to be passed to the SASL mechanisms used for authentication.

saslProtocol

@Deprecated
public T saslProtocol(String value)

Deprecated. Only for use with the legacy security realms.

The name of the protocol to be passed to the SASL mechanisms used for authentication.

secureSocketBinding

public String secureSocketBinding()

The name of the socket binding configuration to use for the HTTPS management interface's socket. When defined at least one of ssl-context or security-realm must also be defined.

secureSocketBinding

public T secureSocketBinding(String value)

The name of the socket binding configuration to use for the HTTPS management interface's socket. When defined at least one of ssl-context or security-realm must also be defined.

securityRealm

@Deprecated
public String securityRealm()

Deprecated. Configuration should migrate to reference 'http-authentication-factory', 'sasl-authentication-factory', and 'ssl-context' capabilities as required.

The legacy security realm to use for the HTTP management interface.

securityRealm

@Deprecated
public T securityRealm(String value)

Deprecated. Configuration should migrate to reference 'http-authentication-factory', 'sasl-authentication-factory', and 'ssl-context' capabilities as required.

The legacy security realm to use for the HTTP management interface.

serverName

@Deprecated
public String serverName()

Deprecated. Only for use with the legacy security realms.

The name of the server used in the initial Remoting exchange and within the SASL mechanisms.

serverName

@Deprecated
public T serverName(String value)

Deprecated. Only for use with the legacy security realms.

The name of the server used in the initial Remoting exchange and within the SASL mechanisms.

socketBinding

public String socketBinding()

The name of the socket binding configuration to use for the HTTP management interface's socket.

socketBinding

public T socketBinding(String value)

The name of the socket binding configuration to use for the HTTP management interface's socket.

sslContext

public String sslContext()

Reference to the SSLContext to use for this management interface.

sslContext

public T sslContext(String value)

Reference to the SSLContext to use for this management interface.