public interface Pin
Pin
interface represents a token which may be used to access
the system without a password. Each such token belongs to a user on whose
behalf access is granted.
The use of a PIN may further be restricted by the number
of times
it may be used and an expiry time
.
Additionally the PIN may be enabled or disabled
.
This interface is not intended to be implemented by clients. Instances of
this interface are returned by the methods of the PinManager
.
Modifier and Type | Method and Description |
---|---|
long |
getExpiryTime()
Deprecated.
Returns the expiry time in milliseconds since the epoch.
|
String |
getId()
Deprecated.
Returns the ID of this pin.
|
int |
getMaxUse()
Deprecated.
Returns the maximum number of times this PIN may be used.
|
int |
getUseCounter()
Deprecated.
Return the total number times this PIN has already been used.
|
String |
getUserId()
Deprecated.
Returns ID of the user to which this PIN belongs.
|
Iterator<PinUse> |
getUses()
Deprecated.
Returns an iterator
PinUse objects of the recorded uses of this
PIN. |
boolean |
isEnabled()
Deprecated.
Returns
true if this PIN is currently enabled. |
void |
setAge(int age)
Deprecated.
Sets the maximum age in seconds of this PIN.
|
void |
setEnabled(boolean enabled)
Deprecated.
Enables or disables this PIN.
|
void |
setExpiryTime(long expiryTime)
Deprecated.
Sets the time in milliseconds since the epoch of the expiry of this PIN.
|
void |
setMaxUse(int maxUse)
Deprecated.
Sets the maximum number of number of time this PIN may be used.
|
String getId()
:cqpin
request parameter or cookie to get access to the
system.String getUserId()
int getUseCounter()
boolean isEnabled()
true
if this PIN is currently enabled.int getMaxUse()
long getExpiryTime()
void setEnabled(boolean enabled)
This method may only be called the PIN owner or by PIN administrators.
enabled
- true
to enable the PIN and false
to disable this PIN.void setMaxUse(int maxUse)
This method does not reset the use counter
. Thus
if this number is less than or equal to the current use counter, the PIN
becomes invalid immediately.
This method may only be called the PIN owner or by PIN administrators.
maxUse
- The maximum number of uses of this PIN. If this value is
negative, the use of the PIN is not limited by the use
counter.void setExpiryTime(long expiryTime)
expiryTime
- The expiry time in milliseconds since the epoch. If
this time is negative, the PIN will never expire. If this time
is in the past, the PIN becomes invalid immediately.void setAge(int age)
The age must be positive number. Specifying a negative number will have
no effect. To switch off the PIN expiry the setExpiryTime(long)
must be called with a negative value.
age
- The maximum age in seconds of this PIN. This must be a
positive number. If this is called with a negative number,
this method has no effect."Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"