Package org.apache.directory.fortress.core.util.time

Class Timeout

java.lang.Object

org.apache.directory.fortress.core.util.time.Timeout

All Implemented Interfaces:

Validator

public class Timeout
extends Object
implements Validator

This class performs timeout validation for Constraint. This validator will ensure the elapsed time an entity is active is less than Constraint.getTimeout() and Constraint.getEndTime() The timeout is in minutes and is stored as integer value. i.e. 30 for 30 minutes. A value of '0' specifies no timeout for a particular entity.

Constraint Targets include

1. User maps to 'ftCstr' attribute on 'ftUserAttrs' object class
2. UserRole maps to 'ftRC' attribute on 'ftUserAttrs' object class
3. Role maps to 'ftCstr' attribute on 'ftRls' object class
4. AdminRole maps to 'ftCstr' attribute on 'ftRls' object class
5. UserAdminRole maps to 'ftARC' attribute on 'ftRls' object class

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
Timeout()

Method Summary

Modifier and Type	Method	Description
int	validate(Session session, Constraint constraint, Time time, VUtil.ConstraintType type)	This method is called during entity activation, VUtil.validateConstraints(org.apache.directory.fortress.core.model.Session, org.apache.directory.fortress.core.util.VUtil.ConstraintType, boolean) and ensures the elapsed time a particular entity has been activated does not exceed specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

Timeout

public Timeout()

Method Detail

validate

public int validate(Session session,
                    Constraint constraint,
                    Time time,
                    VUtil.ConstraintType type)

This method is called during entity activation, VUtil.validateConstraints(org.apache.directory.fortress.core.model.Session, org.apache.directory.fortress.core.util.VUtil.ConstraintType, boolean) and ensures the elapsed time a particular entity has been activated does not exceed specified. value Constraint.getTimeout().

Specified by:

validate in interface Validator

Parameters:

session - required for Validator interface but not used here.

constraint - contains the elapsed time entity may remain inactive in minutes. Maps listed above.

time - contains the current timestamp.

type - required by interface, not used here.

Returns:

'0' if validation succeeds else GlobalErrIds.ACTV_FAILED_TIMEOUT if failed.