public class AttributeDeltaBuilder extends Object
Constructor and Description |
---|
AttributeDeltaBuilder() |
Modifier and Type | Method and Description |
---|---|
AttributeDeltaBuilder |
addValueToAdd(Collection<?> obj)
Adds each object in the collection as a value for the valuesToAdd of the
attributeDelta that is being built.
|
AttributeDeltaBuilder |
addValueToAdd(Object... objs)
Adds each of the specified objects as a value for the valuesToAdd of the
attributeDelta that is being built.
|
AttributeDeltaBuilder |
addValueToRemove(Collection<?> obj)
Adds each object in the collection as a value for the valuesToRemove of
the attributeDelta that is being built.
|
AttributeDeltaBuilder |
addValueToRemove(Object... objs)
Adds each of the specified objects as a value for the valuesToRemove of
the attributeDelta that is being built.
|
AttributeDeltaBuilder |
addValueToReplace(Collection<?> obj)
Adds each object in the collection as a value for the valuesToReplace of
the attributeDelta that is being built.
|
AttributeDeltaBuilder |
addValueToReplace(Object... objs)
Adds each of the specified objects as a value for the valuesToReplace of
the attributeDelta that is being built.
|
AttributeDelta |
build()
Creates a attributeDelta with the specified name and the value for
valuesToAdd, valuesToRemove and valuesToReplace that have been provided
to the builder.
|
static AttributeDelta |
build(String name)
Creates a attributeDelta with the specified name and a
null value
for valuesToAdd, valuesToRemove and valuesToReplace. |
static AttributeDelta |
build(String name,
Collection<?> valuesToReplace)
Creates an
AttributeDelta with the name and the values provided
for valuesToReplace. |
static AttributeDelta |
build(String name,
Collection<?> valuesToAdd,
Collection<?> valuesToRemove)
Creates an
AttributeDelta with the name and the values provided
for valuesToAdd and valuesToRemove. |
static AttributeDelta |
build(String name,
Object... args)
Creates an
AttributeDelta with the name and the values provided
for valuesToReplace. |
static AttributeDelta |
buildCurrentPassword(char[] password)
Builds an of operational attribute that
represents the current password of an object on a target system or
application.
|
static AttributeDelta |
buildCurrentPassword(GuardedString password)
Builds an of operational attribute that
represents the current password of an object on a target system or
application.
|
static AttributeDelta |
buildDisableDate(Date date)
Builds an of operational attribute that
represents the date and time to disable an object on a target system or
application.
|
static AttributeDelta |
buildDisableDate(long date)
Builds an of operational attribute that
represents the date and time to disable an object on a target system or
application.
|
static AttributeDelta |
buildEnabled(boolean value)
Builds an of operational attribute that
represents whether object is enabled on a target system or application.
|
static AttributeDelta |
buildEnableDate(Date date)
Builds an of operational attribute that
represents the date and time to enable an object on a target system or
application.
|
static AttributeDelta |
buildEnableDate(long date)
Builds an of operational attribute that
represents the date and time to enable an object on a target system or
application.
|
static AttributeDelta |
buildLastLoginDate(Date date)
Builds an of pre-defined attribute that
represents the date and time of the most recent login for an object (such
as an account) on a target system or application.
|
static AttributeDelta |
buildLastLoginDate(long date)
Builds an of pre-defined attribute that
represents the date and time of the most recent login for an object (such
as an account) on a target system or application.
|
static AttributeDelta |
buildLastPasswordChangeDate(Date date)
Builds an of pre-defined attribute that
represents the date and time that the password was most recently changed
for an object (such as an account) on a target system or application.
|
static AttributeDelta |
buildLastPasswordChangeDate(long date)
Builds an of pre-defined attribute that
represents the date and time that the password was most recently changed
for an object (such as an account) on a target system or application.
|
static AttributeDelta |
buildLockOut(boolean lock)
Builds an of operational attribute that
represents whether an object is locked out on a target system or
application.
|
static AttributeDelta |
buildPassword(char[] password)
Builds an of operational attribute that
represents the password of an object on a target system or application.
|
static AttributeDelta |
buildPassword(GuardedString password)
Builds an of operational attribute that
represents the password of an object on a target system or application.
|
static AttributeDelta |
buildPasswordChangeInterval(long value)
Builds an of pre-defined attribute that
represents how often the password must be changed for an object (such as
an account) on a target system or application.
|
static AttributeDelta |
buildPasswordExpirationDate(Date dateTime)
Builds an of operational attribute that
represents the date and time that a password will expire on a target
system or application.
|
static AttributeDelta |
buildPasswordExpirationDate(long dateTime)
Builds an of operational attribute that
represents the date and time that a password will expire on a target
system or application.
|
static AttributeDelta |
buildPasswordExpired(boolean value)
Builds an of operational attribute that
represents whether the password of an object is expired on a target
system or application.
|
String |
getName()
Get the name of the attributeDelta that is being built.
|
List<Object> |
getValuesToAdd()
Return any current value of the valuesToAdd in the attributeDelta that is
being built.
|
List<Object> |
getValueToRemove()
Return any current value of the valuesToRemove in the the attributeDelta
that is being built.
|
List<Object> |
getValueToReplace()
Return any current value of the valuesToReplace in the attribute that is
being built.
|
AttributeDeltaBuilder |
setName(String name)
Set the name of the attributeDelta that is being built.
|
public static AttributeDelta build(String name)
null
value
for valuesToAdd, valuesToRemove and valuesToReplace.name
- unique name of the attributeDelta.AttributeDelta
with a null
or actual values for
valuesToAdd, valuesToRemove and valuesToReplace.public static AttributeDelta build(String name, Collection<?> valuesToAdd, Collection<?> valuesToRemove)
AttributeDelta
with the name and the values provided
for valuesToAdd and valuesToRemove.name
- unique name of the attributeDelta.valuesToAdd
- a collection of objects that are used as values for the
valuesToAdd of the attributeDelta.valuesToRemove
- a collection of objects that are used as values for the
valuesToRemove of the attributeDelta.AttributeDelta
with the specified name and a
value that includes the arguments provided.public static AttributeDelta build(String name, Object... args)
AttributeDelta
with the name and the values provided
for valuesToReplace.name
- unique name of the attributeDelta.args
- variable number of arguments that are used as values for the
valuesToReplace of the attributeDelta.AttributeDelta
with the specified name and a
value that includes the arguments provided.public static AttributeDelta build(String name, Collection<?> valuesToReplace)
AttributeDelta
with the name and the values provided
for valuesToReplace.name
- unique name of the attributeDelta.valuesToReplace
- a collection of objects that are used as values for the
valuesToReplace of the attributeDelta.AttributeDelta
with the specified name and a
value that includes the arguments provided.public String getName()
public AttributeDeltaBuilder setName(String name)
AttributeDelta
with the specified name and a
value that includes the arguments provided.IllegalArgumentException
- if the name parameter is blank.public List<Object> getValuesToAdd()
public List<Object> getValueToRemove()
public List<Object> getValueToReplace()
public AttributeDeltaBuilder addValueToAdd(Collection<?> obj)
obj
- the values to add for ValueToAddAttributeDelta
with the specified name and a
value that includes the arguments provided.public AttributeDeltaBuilder addValueToAdd(Object... objs)
objs
- the values to add for ValueToAddAttributeDelta
with the specified name and a
value that includes the arguments provided.public AttributeDeltaBuilder addValueToRemove(Collection<?> obj)
obj
- the values to add for ValueToRemoveNullPointerException
- if any of the values is null.IllegalArgumentException
- if no name has been provided.public AttributeDeltaBuilder addValueToRemove(Object... objs)
objs
- the values to add for ValueToRemoveAttributeDelta
with the specified name and a
value that includes the arguments provided.public AttributeDeltaBuilder addValueToReplace(Collection<?> obj)
obj
- the values to add for ValueToReplaceNullPointerException
- if any of the values is null.IllegalArgumentException
- if no name has been provided.public AttributeDeltaBuilder addValueToReplace(Object... objs)
objs
- the values to add for ValueToReplaceAttributeDelta
with the specified name and a
value that includes the arguments provided.public AttributeDelta build()
AttributeDelta
with name and
List<Object>
for valuesToAdd, valuesToRemove and
valuesToReplace.IllegalArgumentException
- if no name has been provided.public static AttributeDelta buildPasswordExpirationDate(Date dateTime)
dateTime
- UTC time in milliseconds.AttributeDelta
with the
pre-defined name for password expiration date.public static AttributeDelta buildPasswordExpirationDate(long dateTime)
dateTime
- UTC time in milliseconds.AttributeDelta
with the
pre-defined name for password expiration date.public static AttributeDelta buildPassword(GuardedString password)
password
- the string that represents a password.AttributeDelta
with the
predefined name
for password.public static AttributeDelta buildPassword(char[] password)
The caller is responsible for clearing out the array of characters.
password
- the characters that represent a password.AttributeDelta
with the
predefined name
for password.public static AttributeDelta buildCurrentPassword(GuardedString password)
Passing the current password indicates the account owner (and not an administrator) is changing the password. The use case is that an administrator password change may not keep history or validate against policy.
password
- the string that represents a password.AttributeDelta
with the
predefined name for current password.public static AttributeDelta buildCurrentPassword(char[] password)
Passing the current password indicates the account owner (and not an administrator) is changing the password. The use case is that an administrator password change may not keep history or validate against policy.
The caller is responsible for clearing out the array of characters.
password
- the characters that represent a password.AttributeDelta
with the
predefined name for current password.public static AttributeDelta buildEnabled(boolean value)
CreateApiOp
or
UpdateApiOp
to
enable or disable an object.GetApiOp
to
determine whether an object currently is enabled or disabled.SearchApiOp
to select objects that
are enabled or to select objects that are disabled.value
- true indicates the object is enabled; otherwise false.AttributeDelta
with the
predefined name for
enabled.public static AttributeDelta buildEnableDate(Date date)
CreateApiOp
or
UpdateApiOp
to
set a date and time to enable an object.GetApiOp
to
determine when an object will be enabled.SearchApiOp
to select objects that
are scheduled to be enabled at a certain date and time.date
- The date and time to enable a particular object.AttributeDelta
with the
predefined
name for enable date.public static AttributeDelta buildEnableDate(long date)
CreateApiOp
or
UpdateApiOp
to
set a date and time to enable an object.GetApiOp
to
determine when an object will be enabled.SearchApiOp
to select objects that
are scheduled to be enabled at a certain date and time.date
- The date and time (UTC in milliseconds) to enable a particular
object.AttributeDelta
with the
predefined
name for enable date.public static AttributeDelta buildDisableDate(Date date)
CreateApiOp
or
UpdateApiOp
to
set a date and time to disable an object.GetApiOp
to
determine when an object will be disabled.SearchApiOp
to select objects that
are scheduled to be disabled at a certain date and time.date
- The date and time to disable a particular object.AttributeDelta
with the
predefined
name for disable date.public static AttributeDelta buildDisableDate(long date)
CreateApiOp
or
UpdateApiOp
to
set a date and time to disable an object.GetApiOp
to
determine when an object will be disabled.SearchApiOp
to select objects that
are scheduled to be disabled at a certain date and time.date
- The date and time (UTC in milliseconds) to disable a
particular object.AttributeDelta
with the
predefined
name for disable date.public static AttributeDelta buildLockOut(boolean lock)
GetApiOp
to
determine whether an object is currently locked out.UpdateApiOp
to
clear the lock-out status of an object (or to set the lock-out status of
an object).SearchApiOp
to select objects that
are currently locked out (or to select objects that are not currently
locked out).lock
- true if the object is locked out; otherwise false.AttributeDelta
with the
predefined name
for lockout state.public static AttributeDelta buildPasswordExpired(boolean value)
GetApiOp
to
determine whether the password of an object is currently expired.UpdateApiOp
to
expire the password of an object (or to clear the expired status of the
password of an object).SearchApiOp
to select objects that
have passwords that are currently expired (or to select objects that have
passwords that are not currently expired).value
- from the API true expires and from the SPI its shows its
either expired or not.AttributeDelta
with the
predefined name for password expiration state.public static AttributeDelta buildLastLoginDate(Date date)
date
- The date and time of the last login.AttributeDelta
with the
predefined
name for password expiration state.public static AttributeDelta buildLastLoginDate(long date)
The time parameter is UTC in milliseconds.
date
- The date and time (UTC in milliseconds) of the last login.AttributeDelta
with the
predefined
name for password expiration state.public static AttributeDelta buildLastPasswordChangeDate(Date date)
date
- The date and time that the password was most recently changed.AttributeDelta
with the
predefined name for password expiration state.public static AttributeDelta buildLastPasswordChangeDate(long date)
The time parameter is UTC in milliseconds.
date
- The date and time that the password was most recently changed.AttributeDelta
with the
predefined name for password expiration state.public static AttributeDelta buildPasswordChangeInterval(long value)
The value for this attribute is expressed in milliseconds.
value
- The number of milliseconds between the time that the password
was most recently changed and the time when the password must
be changed again.AttributeDelta
with the
predefined name for password expiration state.Copyright © 2019. All rights reserved.