org.picketlink.idm.model

Interface Agent

All Superinterfaces:

AttributedType, IdentityType, Serializable

All Known Subinterfaces:

User

All Known Implementing Classes:

SimpleAgent, SimpleUser

public interface Agent
extends IdentityType

Represents an external entity that interacts with the application, such as a user or a third party application

Author:

Shane Bryzak

Nested Class Summary

Nested classes/interfaces inherited from interface org.picketlink.idm.model.AttributedType

AttributedType.ATTRIBUTE, AttributedType.AttributeParameter

Field Summary

Fields

Modifier and Type	Field and Description
static QueryParameter	LOGIN_NAME A query parameter used to set the key value.

Fields inherited from interface org.picketlink.idm.model.IdentityType

CREATED_AFTER, CREATED_BEFORE, CREATED_DATE, ENABLED, EXPIRY_AFTER, EXPIRY_BEFORE, EXPIRY_DATE, GROUP_ROLE_OF, HAS_GROUP_ROLE, HAS_MEMBER, HAS_ROLE, MEMBER_OF, PARTITION, ROLE_OF

Fields inherited from interface org.picketlink.idm.model.AttributedType

ID

Method Summary

Methods

Modifier and Type	Method and Description
String	getLoginName() Returns the login name of this agent.
void	setLoginName(String loginName)

Methods inherited from interface org.picketlink.idm.model.IdentityType

getCreatedDate, getExpirationDate, getPartition, isEnabled, setCreatedDate, setEnabled, setExpirationDate, setPartition

Methods inherited from interface org.picketlink.idm.model.AttributedType

getAttribute, getAttributes, getId, removeAttribute, setAttribute, setId

Field Detail

LOGIN_NAME

static final QueryParameter LOGIN_NAME

A query parameter used to set the key value.

Method Detail

getLoginName

String getLoginName()

Returns the login name of this agent. This value should be unique, as it is used to identify the agent for authentication

Returns:

setLoginName

void setLoginName(String loginName)