public class CSApiKeyContent extends CSItemContent
CSApiKey
object.
The set/get
methods within CSApiKey
provide access to this content data.
CSApiKey
,
Serialized FormConstructor and Description |
---|
CSApiKeyContent()
Creates an empty
CSApiKeyContent object. |
Modifier and Type | Method and Description |
---|---|
CSItemContent |
createInstance()
Creates a new
CSApiKeyContent object and returns it as a CSItemContent , its superclass. |
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSApiKeyContent object is the same as that contained
within the one supplied. |
java.util.UUID |
getApiKey()
Gets the Api Key currently specified as key information.
|
java.lang.String |
getComments()
Returns comments associated with the Api Key
|
java.util.Date |
getCreated()
Returns the Api Key's created timestamp
|
boolean |
getEnabled()
Returns whether the Api Key is enabled
|
java.util.List<CSApiKeyIpRule> |
getIpRules()
Returns a list of
CSApiKeyIpRule s associated with the Api Key. |
boolean |
getKeyless()
Returns whether the Api Key is keyless
|
java.lang.String |
getName()
Gets the Api Key name currently specified as key information.
|
boolean |
getProtected()
Returns whether the Api Key is protected
|
java.util.List<CSApiKeyWorker> |
getWorkers()
Returns a list of
CSApiKeyWorker s to associate with the Api Key. |
void |
insertDefaultIpRules()
Defaults to the IP rules that iCM pre-populates by default.
|
void |
setApiKey(java.util.UUID apiKey)
Sets the Api Key to be used as key information
|
void |
setComments(java.lang.String comments)
Sets comments associated with the Api Key
|
void |
setCreated(java.util.Date created)
Sets when the Api Key was created
|
void |
setEnabled(boolean enabled)
Sets whether the Api Key is enabled
|
void |
setIpRules(java.util.List<CSApiKeyIpRule> ipRules)
Sets a list of
CSApiKeyIpRule s to associate with the Api Key. |
void |
setKeyless(boolean keyless)
Sets whether the Api Key is keyless
|
void |
setName(java.lang.String name)
Sets the Api Key name to be used as key information.
|
void |
setProtected(boolean bProtected)
Sets whether the Api Key is protected
|
void |
setWorkers(java.util.List<CSApiKeyWorker> workers)
Sets a list of
CSApiKeyWorker s to associate with the Api Key. |
java.lang.String |
toString()
Provides debug information on the contents of the
CSArticleContent object. |
clone, getID, setID, unset
public CSApiKeyContent()
CSApiKeyContent
object.public void insertDefaultIpRules()
public java.util.UUID getApiKey()
public void setApiKey(java.util.UUID apiKey)
apiKey
- The Api Key to set as key informationpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- The Api Key name, to be used as key informationpublic boolean getEnabled()
public void setEnabled(boolean enabled)
enabled
- Whether the Api Key is enabledpublic boolean getProtected()
public void setProtected(boolean bProtected)
bProtected
- Whether the Api Key is protectedpublic boolean getKeyless()
public void setKeyless(boolean keyless)
keyless
- Whether the Api Key is keylesspublic java.util.Date getCreated()
public void setCreated(java.util.Date created)
created
- When the Api Key was createdpublic java.lang.String getComments()
public void setComments(java.lang.String comments)
comments
- Comments associated with the Api Keypublic java.util.List<CSApiKeyIpRule> getIpRules()
CSApiKeyIpRule
s associated with the Api Key.CSApiKeyIpRule
s associated with the Api Key.public void setIpRules(java.util.List<CSApiKeyIpRule> ipRules)
CSApiKeyIpRule
s to associate with the Api Key.ipRules
- A list of CSApiKeyIpRule
s to associate with the Api Key.public java.util.List<CSApiKeyWorker> getWorkers()
CSApiKeyWorker
s to associate with the Api Key.CSApiKeyWorker
s to associate with the Api Key.public void setWorkers(java.util.List<CSApiKeyWorker> workers)
CSApiKeyWorker
s to associate with the Api Key.workers
- A list of CSApiKeyWorker
s to associate with the Api Key.public CSItemContent createInstance()
CSApiKeyContent
object and returns it as a CSItemContent
, its superclass.
This is used by the clone
method in CSItemContent
.
CSApiKeyContent
object.public java.lang.String toString()
CSArticleContent
object.toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSApiKeyContent
object is the same as that contained
within the one supplied. Note that the key data used for searching is not tested for equality.equals
in class CSItemContent
obj
- the CSApiKeyContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.