public interface IAuthenticationParameters
If you are implementing your own IKeyMasterFormatter
then an object
implementing this IAuthenticationParameters
can be used to pass in additional parameters.
A standard implementation of IAuthenticationParameters
is provided with KeyMaster; see
AuthenticationParameters
.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getExtraDataToSign()
Gets any extra data within the token that KeyMaster will sign.
|
java.lang.String |
getLiberatorUsername()
Gets the username that should be used to log in to Liberator.
|
java.util.Map<java.lang.String,java.lang.String> |
getMappingData()
Gets the mapping data.
|
void |
setExtraDataToSign(java.lang.String value)
Sets any extra data within the token that KeyMaster will sign.
|
void |
setLiberatorUsername(java.lang.String username)
Sets the username that should be used to log in to Liberator.
|
void |
setMappingData(java.util.Map<java.lang.String,java.lang.String> value)
Sets the mapping data.
|
java.lang.String getExtraDataToSign()
void setExtraDataToSign(java.lang.String value)
If you have written a custom authentication module then you can use the setExtraDataToSign
to securely
send information from KeyMaster to your authentication module.
Note: If you are using KeyMaster permissioning then you should not set this property.
value
- the extra data to signjava.lang.String getLiberatorUsername()
This property is used by StreamLink clients to obtain the username that is supplied to a Liberator login request. In a production system this name would normally be the authenticated username, which typically has been authenticated through a single sign-on facility.
This field is used by the
StandardFormatter
.
void setLiberatorUsername(java.lang.String username)
This property is used by StreamLink clients to obtain the username that is supplied to a Liberator login request. In a production system this name would normally be the authenticated username, which typically has been authenticated through a single sign-on facility.
This field is used by the
StandardFormatter
.
username
- the liberator user name.java.lang.IllegalArgumentException
- Thrown when the supplied value is null or empty.java.util.Map<java.lang.String,java.lang.String> getMappingData()
Mapping data will be signed and its values will be available for use in Liberator mappings using %{key}. Keys may only contain alphanumeric, underscore and full stop characters.
void setMappingData(java.util.Map<java.lang.String,java.lang.String> value)
Mapping data will be signed and its values will be available for use in Liberator mappings using %{key}. Keys may only contain alphanumeric, underscore and full stop characters.
value
- the mapping data.java.lang.IllegalArgumentException
- Thrown when the supplied value is null.Please send bug reports and comments to Caplin support