anvil.server.ldap
Class LDAPCitizen

java.lang.Object
  |
  +--anvil.server.ldap.LDAPCitizen

All Implemented Interfaces:

Citizen, Entity, Namespace

public class LDAPCitizen

extends java.lang.Object

implements Citizen

class LDAPCitizen Citizen is based on inetorgperson ldap object schema. It has special use for following inetorgperson attributes:

description - used to save user permission information

physicalDeliveryOfficeName - used to save user attributes One shouldn't alter these values unless he's familar with the format. User attributes that are specified in inetorgperson schema has "ctz." prefix when accessed through getAttribute() - except userPassword of course (use verifyCredentials() and setCredentials()). (Anvil script examle:)
realm = context.getRealm("myRealm"); citizen = realm.getCitizen("foo@njet.org"); println "Common name: ", citizen["ctz.cn"]; println "Shoe size: ", citizen["shoeSize"]; Note. Because Citizen implements Namespace inferface you can access user attributes as they were member fields of citizen object.

Field Summary

static java.lang.String

OTHERS_ATTR

Constructor Summary

LDAPCitizen(LDAPRealm realm, java.lang.String username)

Method Summary

void	addPermission(java.security.Permission perm)
Any	checkVariable(java.lang.String name)
void	commit()
boolean	deleteVariable(java.lang.String name)
boolean	equals(java.lang.Object o)
java.security.PermissionCollection	getCombinedPermissions()
java.lang.String	getName()
Tribe[]	getParents()
java.lang.String	getPassword()
java.security.PermissionCollection	getPermissions()
Realm	getRealm()
Any	getVariable(java.lang.String name)
BindingIterator	getVariables()
java.util.Iterator	listPermissions()
void	remove()
void	removePermission(java.security.Permission perm)
void	setCredentials(java.lang.String newCredentials)
Any	setVariable(java.lang.String name, Any value)
java.lang.String	toString()
boolean	verifyCredentials(java.lang.String credential)

Methods inherited from class java.lang.Object

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

Field Detail

OTHERS_ATTR

public static final java.lang.String OTHERS_ATTR

See Also:

Constant Field Values

Constructor Detail

LDAPCitizen

public LDAPCitizen(LDAPRealm realm,
                   java.lang.String username)
            throws CitizenNotFoundException,
                   OperationFailedException

Method Detail

setVariable

public Any setVariable(java.lang.String name,
                       Any value)

Specified by:

setVariable in interface Namespace

deleteVariable

public boolean deleteVariable(java.lang.String name)

Specified by:

deleteVariable in interface Namespace

getVariable

public Any getVariable(java.lang.String name)

Specified by:

getVariable in interface Namespace

checkVariable

public Any checkVariable(java.lang.String name)

Specified by:

checkVariable in interface Namespace

getVariables

public BindingIterator getVariables()

Specified by:

getVariables in interface Namespace

getRealm

public Realm getRealm()

Specified by:

getRealm in interface Entity

getName

public java.lang.String getName()

Specified by:

getName in interface Entity

verifyCredentials

public boolean verifyCredentials(java.lang.String credential)

Specified by:

verifyCredentials in interface Citizen

setCredentials

public void setCredentials(java.lang.String newCredentials)
                    throws OperationFailedException

Specified by:

setCredentials in interface Citizen

OperationFailedException

getPassword

public java.lang.String getPassword()

getParents

public Tribe[] getParents()

Specified by:

getParents in interface Entity

commit

public void commit()
            throws OperationFailedException

Specified by:

commit in interface Entity

OperationFailedException

getCombinedPermissions

public java.security.PermissionCollection getCombinedPermissions()

Specified by:

getCombinedPermissions in interface Entity

getPermissions

public java.security.PermissionCollection getPermissions()

Specified by:

getPermissions in interface Entity

addPermission

public void addPermission(java.security.Permission perm)
                   throws OperationFailedException

Specified by:

addPermission in interface Entity

OperationFailedException

removePermission

public void removePermission(java.security.Permission perm)
                      throws OperationFailedException

Specified by:

removePermission in interface Entity

OperationFailedException

listPermissions

public java.util.Iterator listPermissions()

Specified by:

listPermissions in interface Entity

remove

public void remove()
            throws OperationFailedException

Specified by:

remove in interface Entity

OperationFailedException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object