public interface Rest2ldapEndpointCfgClient extends HttpEndpointCfgClient
The Rest2LDAP Endpoint provides RESTful access to LDAP application data using a set of customizable data transformations.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends Rest2ldapEndpointCfgClient,? extends Rest2ldapEndpointCfg> |
definition()
Get the configuration definition associated with this Rest2LDAP Endpoint.
|
ValueOrExpression<String> |
getConfigDirectory()
Gets the "config-directory" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<Boolean> |
isReturnNullForMissingProperties()
Gets the "return-null-for-missing-properties" property.
|
void |
setConfigDirectory(ValueOrExpression<String> value)
Sets the "config-directory" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setReturnNullForMissingProperties(ValueOrExpression<Boolean> value)
Sets the "return-null-for-missing-properties" property.
|
getAuthorizationMechanism, getBasePath, isEnabled, setAuthorizationMechanism, setBasePath, setEnabled
commit, properties
ManagedObjectDefinition<? extends Rest2ldapEndpointCfgClient,? extends Rest2ldapEndpointCfg> definition()
definition
in interface ConfigurationClient
definition
in interface HttpEndpointCfgClient
@MandatoryProperty ValueOrExpression<String> getConfigDirectory()
The directory containing the Rest2Ldap configuration file(s) for this specific endpoint.
The directory must be readable by the server and may contain multiple configuration files, one for each supported version of the REST endpoint. If a relative path is used then it will be resolved against the server's instance directory.
@MandatoryProperty void setConfigDirectory(ValueOrExpression<String> value) throws PropertyException
The directory containing the Rest2Ldap configuration file(s) for this specific endpoint.
The directory must be readable by the server and may contain multiple configuration files, one for each supported version of the REST endpoint. If a relative path is used then it will be resolved against the server's instance directory.
value
- The value of the "config-directory" property.PropertyException
- If the new value is invalid.@MandatoryProperty ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the Rest2LDAP Endpoint implementation.
getJavaClass
in interface HttpEndpointCfgClient
@MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the Rest2LDAP Endpoint implementation.
setJavaClass
in interface HttpEndpointCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isReturnNullForMissingProperties()
Indicates whether missing (unmapped) JSON properties should be included in JSON resources.
By default JSON properties that do not have a corresponding LDAP attribute are unmapped and not included in JSON resources returned by the REST endpoint. Set this option to true if unmapped JSON properties should be included with a value of null.
void setReturnNullForMissingProperties(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether missing (unmapped) JSON properties should be included in JSON resources.
By default JSON properties that do not have a corresponding LDAP attribute are unmapped and not included in JSON resources returned by the REST endpoint. Set this option to true if unmapped JSON properties should be included with a value of null.
value
- The value of the "return-null-for-missing-properties" property.PropertyException
- If the new value is invalid.Copyright 2010-2022 ForgeRock AS.