com.appiancorp.suiteapi.common

Class Credentials

java.lang.Object

com.appiancorp.suiteapi.common.Credentials

All Implemented Interfaces:

com.appian.komodo.api.EngineCredentials, java.io.Serializable

public class Credentials
extends java.lang.Object
implements com.appian.komodo.api.EngineCredentials, java.io.Serializable

Bean that represents a User's credentials

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	Credentials() Credentials Empty constructor.
	Credentials(com.appiancorp.ag.ImmutableCredentials copySource, java.lang.String tenant, boolean includeGroupMembership) Credentials copy constructor with tenant modification.
protected	Credentials(com.google.common.collect.ImmutableSet<java.lang.Long> adminGroups, com.google.common.collect.ImmutableSet<java.lang.Long> memberGroups, com.google.common.collect.ImmutableSet<java.lang.String> memberGroupUuids, int userType, java.lang.String username, java.lang.String tenant, java.lang.String userUuid, java.lang.Integer userGroupsLocalId) Constructs the bean that represents a User's credentials.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.Long>	getAdminGroups() Group IDs for those groups where the user is an administrator.
java.lang.String	getIdentity() Gets the username of the user to whom these credentials belong.
java.util.Set<java.lang.Long>	getMemberGroups() Group IDs for those groups where the user is a member.
java.util.Set<java.lang.String>	getMemberGroupUuids() Returns the UUIDs of the groups where the user is a member.
java.lang.Object	getPayload() Returns the credentials in the format that is expected by the backend when they are passed along with an API call.
java.lang.String	getTenant() Tenant's identifier
java.lang.Integer	getUserGroupsLocalId()
int	getUserType() User's type
java.lang.String	getUserUuid()
void	setAdminGroups(java.util.Set<java.lang.Long> adminGroups_) Sets the Group IDs for those groups where the user is an administrator.
void	setIdentity(java.lang.String username_) Sets the username of the user to whom these credentials belong.
void	setMemberGroups(java.util.Set<java.lang.Long> memberGroups_) Sets the Group IDs for those groups where the user is a member.
void	setMemberGroupUuids(java.util.Set<java.lang.String> memberGroupUuids) Sets the UUIDs of the groups where the user is a member.
void	setTenant(java.lang.String tenant_) Sets the user's tenant identifier
void	setUserGroupsLocalId(java.lang.Integer userGroupsLocalId_)
void	setUserType(int userType_) Sets the user's type
void	setUserUuid(java.lang.String userUuid_)
java.lang.String	toString() Debug representation of Credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

Credentials

public Credentials()

Credentials Empty constructor.

Credentials

public Credentials(com.appiancorp.ag.ImmutableCredentials copySource,
                   java.lang.String tenant,
                   boolean includeGroupMembership)

Credentials copy constructor with tenant modification.

Parameters:

copySource -

tenant -

includeGroupMembership - true for engines other than Process, which retains cached groups itself for background processing

Credentials

protected Credentials(com.google.common.collect.ImmutableSet<java.lang.Long> adminGroups,
                      com.google.common.collect.ImmutableSet<java.lang.Long> memberGroups,
                      com.google.common.collect.ImmutableSet<java.lang.String> memberGroupUuids,
                      int userType,
                      java.lang.String username,
                      java.lang.String tenant,
                      java.lang.String userUuid,
                      java.lang.Integer userGroupsLocalId)

Constructs the bean that represents a User's credentials. The bean is created automatically by the system and should not be constructed by third-party developers in plug-ins. Expects ImmutableSets to be used in creating Credentials. To be used in subclasses that do not want to be able to modify fields of Credentials.

Method Detail

getAdminGroups

public java.util.Set<java.lang.Long> getAdminGroups()

Group IDs for those groups where the user is an administrator.

Returns:

Set of group IDs for those where the user is an administrator.

setAdminGroups

public void setAdminGroups(java.util.Set<java.lang.Long> adminGroups_)

Sets the Group IDs for those groups where the user is an administrator.

Parameters:

adminGroups_ - Set with the group IDs for the groups where the user is an administrator.

getMemberGroups

public java.util.Set<java.lang.Long> getMemberGroups()

Group IDs for those groups where the user is a member.

Returns:

Set of group IDs for those where the user is a member.

setMemberGroups

public void setMemberGroups(java.util.Set<java.lang.Long> memberGroups_)

Sets the Group IDs for those groups where the user is a member.

Parameters:

memberGroups_ - Set with the group IDs for the groups where the user is a member.

getMemberGroupUuids

public java.util.Set<java.lang.String> getMemberGroupUuids()

Returns the UUIDs of the groups where the user is a member.

setMemberGroupUuids

public void setMemberGroupUuids(java.util.Set<java.lang.String> memberGroupUuids)

Sets the UUIDs of the groups where the user is a member.

getUserType

public int getUserType()

User's type

Returns:

The user's type.

setUserType

public void setUserType(int userType_)

Sets the user's type

Parameters:

userType_ -

setIdentity

public void setIdentity(java.lang.String username_)

Sets the username of the user to whom these credentials belong.

Parameters:

username_ -

getIdentity

public java.lang.String getIdentity()

Gets the username of the user to whom these credentials belong.

Specified by:

getIdentity in interface com.appian.komodo.api.EngineCredentials

getTenant

public java.lang.String getTenant()

Tenant's identifier

Returns:

The current tenant identifier

setTenant

public void setTenant(java.lang.String tenant_)

Sets the user's tenant identifier

Parameters:

tenant_ - tenant identifier

getPayload

public java.lang.Object getPayload()

Returns the credentials in the format that is expected by the backend when they are passed along with an API call. The format is an array with elements. The elements are: (0) Username (String) (1) Member groups (int[]) (2) Admin groups (int[]) (3) User type (Integer) (4) Tenant (String) (5) Current thread hashcode (Integer) (6) Designate as migration call (Integer) - always 0 here (7) User UUID (8) User Groups Local ID Note that the groups must be passed as int[], because com.appiancorp.kougar.driver.ipc.IpcConnection does not support Long[] or Integer[]. Also, the user type must be passed as Integer, because the same class also does not support Long or int.

Specified by:

getPayload in interface com.appian.komodo.api.EngineCredentials

getUserUuid

public java.lang.String getUserUuid()

setUserUuid

public void setUserUuid(java.lang.String userUuid_)

getUserGroupsLocalId

public java.lang.Integer getUserGroupsLocalId()

setUserGroupsLocalId

public void setUserGroupsLocalId(java.lang.Integer userGroupsLocalId_)

toString

public java.lang.String toString()

Debug representation of Credentials.

Overrides:

toString in class java.lang.Object

Returns:

String