public class CSApiKeyWorker
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AUTHTYPE_ICMUSERS |
static java.lang.String |
AUTHTYPE_NONE |
static java.lang.String |
AUTHTYPE_WEBUSERS |
Constructor and Description |
---|
CSApiKeyWorker()
Creates an empty
CSApiKeyContent object. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Makes a new copy of this object.
|
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.lang.String |
getAuthType()
Returns the auth type of the worker.
|
CSApiKeyWorkerDefaultCredentials |
getDefaultCredentials()
Returns default credentials defined for this Api Key Worker.
|
java.util.List<java.lang.Long> |
getIcmUserGroups()
Returns a list of IDs belonging to iCM user groups that the user must be within
in order to call this Api Key.
|
java.util.List<CSApiKeyMethodFilter> |
getMethodFilters()
Returns method filters defined against this Api Key Worker.
|
java.lang.String |
getName()
Returns the name of the Api Key Worker
|
java.util.List<java.lang.Long> |
getSiteUserGroups()
Returns a list of IDs belonging to site user groups that the user must be within
in order to call this Api Key.
|
void |
setAuthType(java.lang.String authType)
Sets the auth type of the worker.
|
void |
setDefaultCredentials(CSApiKeyWorkerDefaultCredentials defaultCredentials)
Sets default credentials defined for this Api Key Worker.
|
void |
setIcmUserGroups(java.util.List<java.lang.Long> icmUserGroups)
Sets a list of IDs belonging to iCM user groups that the user must be within
in order to call this Api Key.
|
void |
setMethodFilters(java.util.List<CSApiKeyMethodFilter> methodFilters)
Sets method filters defined against this Api Key Worker.
|
void |
setName(java.lang.String name)
Sets the name of the API Key Worker
|
void |
setSiteUserGroups(java.util.List<java.lang.Long> siteUserGroups)
Sets a list of IDs belonging to site user groups that the user must be within
in order to call this Api Key.
|
java.lang.String |
toString()
Provides debug information on the contents of the
CSApiKeyWorker object. |
public static final java.lang.String AUTHTYPE_NONE
public static final java.lang.String AUTHTYPE_ICMUSERS
public static final java.lang.String AUTHTYPE_WEBUSERS
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name of the API Key Workerpublic java.lang.String getAuthType()
public void setAuthType(java.lang.String authType)
authType
- The auth type of the worker.public java.util.List<java.lang.Long> getIcmUserGroups()
AUTHTYPE_ICMUSERS
.public void setIcmUserGroups(java.util.List<java.lang.Long> icmUserGroups)
AUTHTYPE_ICMUSERS
.icmUserGroups
- A list of IDs belonging to iCM user groupspublic java.util.List<java.lang.Long> getSiteUserGroups()
AUTHTYPE_WEBUSERS
.public void setSiteUserGroups(java.util.List<java.lang.Long> siteUserGroups)
AUTHTYPE_WEBUSERS
.siteUserGroups
- A list of IDs belonging to site user groupspublic CSApiKeyWorkerDefaultCredentials getDefaultCredentials()
public void setDefaultCredentials(CSApiKeyWorkerDefaultCredentials defaultCredentials)
defaultCredentials
- Default credentials to define for this Api Key Worker. May be null.public java.util.List<CSApiKeyMethodFilter> getMethodFilters()
public void setMethodFilters(java.util.List<CSApiKeyMethodFilter> methodFilters)
methodFilters
- method filters to define for this Api Key Worker. May be null.public java.lang.String toString()
CSApiKeyWorker
object.
toString
in class java.lang.Object
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 java.lang.Object
obj
- the CSApiKeyContent
to be tested for equality.true
if the data matches, false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException, java.lang.OutOfMemoryError
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
- if cloning is not supported/allowed.java.lang.OutOfMemoryError
- if there are any problems allocating memory.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.