public interface HTTPEndpointCfgClient extends ConfigurationClient
The HTTP Endpoint is used to define HTTP endpoint.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends HTTPEndpointCfgClient,? extends HTTPEndpointCfg> |
definition()
Get the configuration definition associated with this HTTP Endpoint.
|
SortedSet<String> |
getAuthorizationMechanism()
Gets the "authorization-mechanism" property.
|
String |
getBasePath()
Gets the "base-path" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
Boolean |
isEnabled()
Gets the "enabled" property.
|
void |
setAuthorizationMechanism(Collection<String> values)
Sets the "authorization-mechanism" property.
|
void |
setBasePath(String value)
Sets the "base-path" property.
|
void |
setEnabled(boolean value)
Sets the "enabled" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
commit, properties
ManagedObjectDefinition<? extends HTTPEndpointCfgClient,? extends HTTPEndpointCfg> definition()
definition
in interface ConfigurationClient
SortedSet<String> getAuthorizationMechanism()
The HTTP authorization mechanisms supported by this HTTP Endpoint.
void setAuthorizationMechanism(Collection<String> values) throws PropertyException
The HTTP authorization mechanisms supported by this HTTP Endpoint.
values
- The values of the "authorization-mechanism" property.PropertyException
- If one or more of the new values are invalid.String getBasePath()
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.
void setBasePath(String value) throws PropertyException, PropertyException
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.
value
- The value of the "base-path" property.PropertyException
- If the new value is invalid.PropertyException
- If this HTTP Endpoint is not being initialized.Boolean isEnabled()
Indicates whether the HTTP Endpoint is enabled.
void setEnabled(boolean value) throws PropertyException
Indicates whether the HTTP Endpoint is enabled.
value
- The value of the "enabled" property.PropertyException
- If the new value is invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the HTTP Endpoint implementation.
void setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the HTTP Endpoint implementation.
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.Copyright 2010-2017 ForgeRock AS.