Package org.forgerock.opendj.server.config.server

Interface HTTPAuthorizationMechanismCfg

All Superinterfaces:

Configuration

All Known Subinterfaces:

HTTPAnonymousAuthorizationMechanismCfg, HTTPBasicAuthorizationMechanismCfg, HTTPOauth2AuthorizationMechanismCfg, HTTPOauth2CtsAuthorizationMechanismCfg, HTTPOauth2FileAuthorizationMechanismCfg, HTTPOauth2OpenamAuthorizationMechanismCfg, HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg

public interface HTTPAuthorizationMechanismCfg
extends Configuration

A server-side interface for querying HTTP Authorization Mechanism settings.

The HTTP Authorization Mechanism is used to define HTTP authorization mechanism.

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(ConfigurationChangeListener<HTTPAuthorizationMechanismCfg> listener)	Register to be notified when this HTTP Authorization Mechanism is changed.
Class<? extends HTTPAuthorizationMechanismCfg>	configurationClass()	Gets the configuration class associated with this HTTP Authorization Mechanism.
String	getJavaClass()	Gets the "java-class" property.
boolean	isEnabled()	Gets the "enabled" property.
void	removeChangeListener(ConfigurationChangeListener<HTTPAuthorizationMechanismCfg> listener)	Deregister an existing HTTP Authorization Mechanism configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Method Detail

configurationClass

Class<? extends HTTPAuthorizationMechanismCfg> configurationClass()

Gets the configuration class associated with this HTTP Authorization Mechanism.

Specified by:

configurationClass in interface Configuration

Returns:

Returns the configuration class associated with this HTTP Authorization Mechanism.

addChangeListener

void addChangeListener(ConfigurationChangeListener<HTTPAuthorizationMechanismCfg> listener)

Register to be notified when this HTTP Authorization Mechanism is changed.

Parameters:

listener - The HTTP Authorization Mechanism configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<HTTPAuthorizationMechanismCfg> listener)

Deregister an existing HTTP Authorization Mechanism configuration change listener.

Parameters:

listener - The HTTP Authorization Mechanism configuration change listener.

isEnabled

boolean isEnabled()

Gets the "enabled" property.

Indicates whether the HTTP Authorization Mechanism is enabled.

Returns:

Returns the value of the "enabled" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the HTTP Authorization Mechanism implementation.

Returns:

Returns the value of the "java-class" property.