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

Interface HttpEndpointCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

AdminEndpointCfgClient, AliveEndpointCfgClient, CrestMetricsEndpointCfgClient, HdapEndpointCfgClient, HealthyEndpointCfgClient, PrometheusEndpointCfgClient, Rest2ldapEndpointCfgClient

public interface HttpEndpointCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying HTTP Endpoint settings.

The HTTP Endpoint is used to define HTTP endpoint.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends HttpEndpointCfgClient,? extends HttpEndpointCfg>	definition()	Get the configuration definition associated with this HTTP Endpoint.
SortedSet<ValueOrExpression<String>>	getAuthorizationMechanism()	Gets the "authorization-mechanism" property.
ValueOrExpression<String>	getBasePath()	Gets the "base-path" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isEnabled()	Gets the "enabled" property.
void	setAuthorizationMechanism(Collection<ValueOrExpression<String>> values)	Sets the "authorization-mechanism" property.
void	setBasePath(ValueOrExpression<String> value)	Sets the "base-path" property.
void	setEnabled(ValueOrExpression<Boolean> value)	Sets the "enabled" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends HttpEndpointCfgClient,? extends HttpEndpointCfg> definition()

Get the configuration definition associated with this HTTP Endpoint.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this HTTP Endpoint.

getAuthorizationMechanism

@MandatoryProperty
SortedSet<ValueOrExpression<String>> getAuthorizationMechanism()

Gets the "authorization-mechanism" property.

The HTTP authorization mechanisms supported by this HTTP Endpoint.

Returns:

Returns the values of the "authorization-mechanism" property.

setAuthorizationMechanism

@MandatoryProperty
void setAuthorizationMechanism(Collection<ValueOrExpression<String>> values)
                        throws PropertyException

Sets the "authorization-mechanism" property.

The HTTP authorization mechanisms supported by this HTTP Endpoint.

Parameters:

values - The values of the "authorization-mechanism" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getBasePath

@MandatoryProperty
ValueOrExpression<String> getBasePath()

Gets the "base-path" property.

All HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found.

Returns:

Returns the value of the "base-path" property.

setBasePath

@MandatoryProperty
void setBasePath(ValueOrExpression<String> value)
          throws PropertyException,
                 PropertyException

Sets the "base-path" property.

All HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found.

This property is read-only and can only be modified during creation of a HTTP Endpoint.

Parameters:

value - The value of the "base-path" property.

Throws:

PropertyException - If the new value is invalid.

PropertyException - If this HTTP Endpoint is not being initialized.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

Indicates whether the HTTP Endpoint is enabled.

Returns:

Returns the value of the "enabled" property.

setEnabled

@MandatoryProperty
void setEnabled(ValueOrExpression<Boolean> value)
         throws PropertyException

Sets the "enabled" property.

Indicates whether the HTTP Endpoint is enabled.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.