BrightSide Workbench Full Report + Source Code
Public Member Functions | Static Public Attributes | List of all members
org.turro.elephant.security.IUser Interface Reference
Inheritance diagram for org.turro.elephant.security.IUser:
Inheritance graph
[legend]

Public Member Functions

boolean validate (String login, String password)
 
boolean validate (String key)
 
boolean validate2 (String password2)
 
boolean impersonate (String login)
 
boolean impersonateByEmail (String email)
 
boolean isValid ()
 
void reload ()
 
boolean isThisUser (String id)
 
String getId ()
 
String getName ()
 
String getProperty (String key)
 
boolean isInRole (String role)
 
boolean hasAnyRoleKey (String role)
 
boolean equals (Object obj)
 
Map getByDescriptors (String value)
 
boolean hasRoleName (String role)
 
List getUsers ()
 
String createTmpKey (Date valid)
 
void setConstructor (IConstructor constructor)
 

Static Public Attributes

static final String CONNECTOR_EMAIL = "Email"
 
static final String CONNECTOR_TRADE = "TradeName"
 
static final String CONNECTOR_FISCAL = "FiscalName"
 
static final String CONNECTOR_EMAIL_LOGIN = "EmailLogin"
 
static final String ADDRESS_FISCAL = "Fiscal"
 
static final String LOGGED_USER = "xp_user"
 
static final String INTERNAL_SIGNIN = "InternalSignIn"
 

Detailed Description

IUser should be implemented by in user management implementations. IConstructor expects an IUser where to check whether a user is in role.

Author
Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 30 of file IUser.java.

Member Function Documentation

◆ createTmpKey()

String org.turro.elephant.security.IUser.createTmpKey ( Date  valid)

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ equals()

boolean org.turro.elephant.security.IUser.equals ( Object  obj)
Returns
True if object is an IUser with the same login

◆ getByDescriptors()

Map org.turro.elephant.security.IUser.getByDescriptors ( String  value)
Returns
A map of users.

Implemented in org.turro.contacts.util.ContactAsUser.

◆ getId()

String org.turro.elephant.security.IUser.getId ( )
Returns
User's identifier.

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ getName()

String org.turro.elephant.security.IUser.getName ( )
Returns
User's name.

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ getProperty()

String org.turro.elephant.security.IUser.getProperty ( String  key)
Parameters
keyAttribute's key.
Returns
Attribute's value.

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ getUsers()

List org.turro.elephant.security.IUser.getUsers ( )

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ hasAnyRoleKey()

boolean org.turro.elephant.security.IUser.hasAnyRoleKey ( String  role)

Implemented in org.turro.elephant.impl.security.AbstractUser, and org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ hasRoleName()

boolean org.turro.elephant.security.IUser.hasRoleName ( String  role)

Implemented in org.turro.contacts.util.ContactAsUser.

◆ impersonate()

boolean org.turro.elephant.security.IUser.impersonate ( String  login)
Parameters
loginUser login.
Returns
True if user was impersonated.

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ impersonateByEmail()

boolean org.turro.elephant.security.IUser.impersonateByEmail ( String  email)

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ isInRole()

boolean org.turro.elephant.security.IUser.isInRole ( String  role)

Usually this method should take this form:

 if(user.isInRole("page:edit")) {
   // edit page
 }
Parameters
roleRole to check.
Returns
True if user is in role.

Implemented in org.turro.elephant.impl.security.AbstractUser, and org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ isThisUser()

boolean org.turro.elephant.security.IUser.isThisUser ( String  id)

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ isValid()

boolean org.turro.elephant.security.IUser.isValid ( )
Here is the caller graph for this function:

◆ reload()

void org.turro.elephant.security.IUser.reload ( )

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ setConstructor()

void org.turro.elephant.security.IUser.setConstructor ( IConstructor  constructor)

Implemented in org.turro.elephant.impl.security.AbstractUser, and org.turro.contacts.util.ContactAsUser.

◆ validate() [1/2]

boolean org.turro.elephant.security.IUser.validate ( String  key)
Parameters
keyTemporal key for validation.
Returns
True if user was impersonated.

Implemented in org.turro.contacts.util.ContactAsUser.

◆ validate() [2/2]

boolean org.turro.elephant.security.IUser.validate ( String  login,
String  password 
)
Parameters
loginUser login.
passwordUser password.
Returns
True if user was validated.

Implemented in org.turro.contacts.util.ContactAsUser.

Here is the caller graph for this function:

◆ validate2()

boolean org.turro.elephant.security.IUser.validate2 ( String  password2)
Parameters
password2User password2.
Returns
True if user validates password2.

Implemented in org.turro.contacts.util.ContactAsUser.

Member Data Documentation

◆ ADDRESS_FISCAL

final String org.turro.elephant.security.IUser.ADDRESS_FISCAL = "Fiscal"
static

Definition at line 36 of file IUser.java.

◆ CONNECTOR_EMAIL

final String org.turro.elephant.security.IUser.CONNECTOR_EMAIL = "Email"
static

Definition at line 32 of file IUser.java.

◆ CONNECTOR_EMAIL_LOGIN

final String org.turro.elephant.security.IUser.CONNECTOR_EMAIL_LOGIN = "EmailLogin"
static

Definition at line 35 of file IUser.java.

◆ CONNECTOR_FISCAL

final String org.turro.elephant.security.IUser.CONNECTOR_FISCAL = "FiscalName"
static

Definition at line 34 of file IUser.java.

◆ CONNECTOR_TRADE

final String org.turro.elephant.security.IUser.CONNECTOR_TRADE = "TradeName"
static

Definition at line 33 of file IUser.java.

◆ INTERNAL_SIGNIN

final String org.turro.elephant.security.IUser.INTERNAL_SIGNIN = "InternalSignIn"
static

Definition at line 38 of file IUser.java.

◆ LOGGED_USER

final String org.turro.elephant.security.IUser.LOGGED_USER = "xp_user"
static

Definition at line 37 of file IUser.java.

The documentation for this interface was generated from the following file: