Package com.isode.dsapi.config

Class OAuthEntry

java.lang.Object

com.isode.dsapi.config.ManagedObject

com.isode.dsapi.config.OAuthEntry

public class OAuthEntry
extends ManagedObject

This class wraps an OAuth configuration entry stored.

Field Summary

Fields inherited from class com.isode.dsapi.config.ManagedObject

logger

Constructor Summary

Constructors

Constructor	Description
OAuthEntry(Entry entry, IsodeDirectorySession ds)	Construct from the entry object.

Method Summary

Modifier and Type	Method	Description
static OAuthEntry	create(IsodeDirectorySession ds, String serverAddress, Integer serverPort, Integer tokenPort, Integer tokenDuration, Integer refreshTokenDuration, Boolean allowNonTLSMode, Boolean useClientStrongAuth)	Construct entry (which will be something like "cn=oauth,cn=config").
Boolean	getAllowNonTLSMode()	Get value of allowNonTLSMode.
Integer	getRefreshTokenDuration()	Get refresh token duration
String	getServerAddress()	Get the server address or hostname.
Integer	getServerPort()	Get the server port.
Boolean	getServiceEnabled()	Get the service enabled flag.
Integer	getTokenDuration()	Get the token duration.
Integer	getTokenPort()	Get the token port.
Boolean	getUseClientStrongAuth()	Get value of useClientStrongAuth.
void	load(Entry entry)	Load values from an entry.
void	setAllowNonTLSMode(Boolean allowNonTLSMode)	Set the value of allowNonTLSMode.
void	setRefreshTokenDuration(Integer refreshTokenDuration)	Set the refresh token duration.
void	setServerAddress(String addr)	Set the server address or hostname.
void	setServerPort(Integer serverPort)	Set the server port.
void	setServiceEnabled(Boolean enabled)	Set the service enabled flag.
void	setTokenDuration(Integer tokenDuration)	Set the token duration.
void	setTokenPort(Integer tokenPort)	Set the token port.
void	setUseClientStrongAuth(Boolean useClientStrongAuth)	Set the value of useClientStrongAuth.

Methods inherited from class com.isode.dsapi.config.ManagedObject

addAttribute, addAttribute, addAttribute, addAttributeValue, addAttributeValue, addEntry, addOC, checkMandatory, checkMandatory, checkMandatory, checkMandatory, commit, commitNoRefresh, createAP, createAttributeType, createDN, createPA, createRDN, createRDN, getAttribute, getAttributeDefaultWhenNull, getDN, getIsodeDirectorySession, getMultiValueBer, getMultiValuedInteger, getMultiValuedInteger, getMultiValuedString, getMultiValuedString, getPA, getValue, getValueAttrTypeFromOID, getValueBer, getValueBoolean, getValueDate, getValueDate, getValueDN, getValueInteger, getValueInteger, getValueString, getValueString, getValueStringFromAttribute, hasAttributeChanged, hasChanges, remove, removeAttr, removeStringValue, reset, reset, updateAttr, updateAttr, updateAttr, updateBoolean, updateDN, updateInteger, updateMultiValuedBER, updateMultiValuedInteger, updateMultiValuedString, updatePA, updatePA, updateString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OAuthEntry

public OAuthEntry(Entry entry,
 IsodeDirectorySession ds)
           throws ConfigOpFailedException

Construct from the entry object.

Parameters:

entry - Entry representing the OAuth config.

ds - Isode directory session

Throws:

ConfigOpFailedException - if mandatory attributes are not loaded

Method Details

load

public void load(Entry entry)
          throws ConfigOpFailedException

Description copied from class: ManagedObject

Load values from an entry. No directory operation should be done in this method.

Mandatory variables are assigned only after everything is ok. This is done so during re-loading, if there are exceptions and even then the object is used, there is no crash by using mandatory variables that are assumed to have non-null values.

Specified by:

load in class ManagedObject

Parameters:

entry - Entry representing the object, could be null if the existing entry has to be reloaded

Throws:

ConfigOpFailedException - if mandatory attributes are not loaded

create

public static OAuthEntry create(IsodeDirectorySession ds,
 String serverAddress,
 Integer serverPort,
 Integer tokenPort,
 Integer tokenDuration,
 Integer refreshTokenDuration,
 Boolean allowNonTLSMode,
 Boolean useClientStrongAuth)
                         throws ConfigOpFailedException,
ReadFailedException

Construct entry (which will be something like "cn=oauth,cn=config").

The returned result will contain attributes containing default values (see code).

Parameters:

ds - Directory session.

Returns:

created Changelog entry

Throws:

ReadFailedException - if there is a problem on reading the committed entry back.

ConfigOpFailedException - if there is a problem on applying the changes to the directory.

getServiceEnabled

public Boolean getServiceEnabled()

Get the service enabled flag.

Returns:

the service enabled flag.

setServiceEnabled

public void setServiceEnabled(Boolean enabled)

Set the service enabled flag.

Parameters:

enabled - The service enabled flag.

getServerAddress

public String getServerAddress()

Get the server address or hostname.

Returns:

the server address (null if not set)

setServerAddress

public void setServerAddress(String addr)

Set the server address or hostname.

Parameters:

addr - New address.

getServerPort

public Integer getServerPort()

Get the server port.

Returns:

Get the server port value (null if not set).

setServerPort

public void setServerPort(Integer serverPort)

Set the server port.

Parameters:

serverPort - Server port value.

getTokenPort

public Integer getTokenPort()

Get the token port.

Returns:

setTokenPort

public void setTokenPort(Integer tokenPort)

Set the token port.

Parameters:

Token - port value.

getTokenDuration

public Integer getTokenDuration()

Get the token duration.

Returns:

Token duration value (null if not set).

setTokenDuration

public void setTokenDuration(Integer tokenDuration)

Set the token duration.

Parameters:

Set - the token duration.

getRefreshTokenDuration

public Integer getRefreshTokenDuration()

Get refresh token duration

Returns:

Refresh token duration value (null if not set).

setRefreshTokenDuration

public void setRefreshTokenDuration(Integer refreshTokenDuration)

Set the refresh token duration.

Parameters:

refreshTokenDuration - Value to set.

getAllowNonTLSMode

public Boolean getAllowNonTLSMode()

Get value of allowNonTLSMode.

Returns:

Value of allowNonTLSMode (null if not set).

setAllowNonTLSMode

public void setAllowNonTLSMode(Boolean allowNonTLSMode)

Set the value of allowNonTLSMode.

Parameters:

allowNonTLSMode - Value to set.

getUseClientStrongAuth

public Boolean getUseClientStrongAuth()

Get value of useClientStrongAuth.

Returns:

Value of useClientStrongAuth (null if not set).

setUseClientStrongAuth

public void setUseClientStrongAuth(Boolean useClientStrongAuth)

Set the value of useClientStrongAuth.

Parameters:

useClientStrongAuth - Value to set.