PresenceExt (pki-javadoc)

java.lang.Object
- org.dogtagpki.legacy.server.policy.APolicyRule
- - org.dogtagpki.legacy.server.policy.extensions.PresenceExt

All Implemented Interfaces:: IPolicy, IPolicyRule

public class PresenceExt
extends APolicyRule

Checks extension presence.

 NOTE:  The Policy Framework has been replaced by the Profile Framework.

Version:: $Revision$, $Date$

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_HOSTNAME`
`static java.lang.String`	`PROP_ID`
`static java.lang.String`	`PROP_IS_CRITICAL`
`static java.lang.String`	`PROP_MAX_USERS`
`static java.lang.String`	`PROP_OID`
`static java.lang.String`	`PROP_PORT_NUMBER`
`static java.lang.String`	`PROP_RFC822_NAME`
`static java.lang.String`	`PROP_SERVICE_LEVEL`
`static java.lang.String`	`PROP_STREET_ADDRESS`
`static java.lang.String`	`PROP_TELEPHONE_NUMBER`
`static java.lang.String`	`PROP_VERSION`

Fields inherited from class org.dogtagpki.legacy.server.policy.APolicyRule
DESC, logger, mFilterExp, mInstanceName, NAME

Fields inherited from interface org.dogtagpki.legacy.policy.IPolicyRule
PROP_ENABLE, PROP_IMPLNAME, PROP_PREDICATE

Constructor Summary

Constructors
Constructor and Description

PresenceExt()

Constructors
Constructor and Description
`PresenceExt()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PolicyResult`	`apply(IRequest req)` Applies the policy on the given Request.
`java.util.Vector<java.lang.String>`	`getDefaultParams()` Return default parameters for a policy implementation.
`java.lang.String[]`	`getExtendedPluginInfo(java.util.Locale locale)`
`java.util.Vector<java.lang.String>`	`getInstanceParams()` Return configured parameters for a policy rule instance.
`void`	`init(IPolicyProcessor owner, IConfigStore config)` Initializes the policy rule.

Methods inherited from class org.dogtagpki.legacy.server.policy.APolicyRule
agentApproved, createKeyIdentifier, deferred, formSHA1KeyId, formSpkiSHA1KeyId, getDescription, getInstanceName, getName, getPredicate, setError, setError, setError, setInstanceName, setPolicyException, setPolicyException, setPredicate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_IS_CRITICAL
```
public static final java.lang.String PROP_IS_CRITICAL
```
    See Also:
    
    Constant Field Values
  - PROP_OID
```
public static final java.lang.String PROP_OID
```
    See Also:
    
    Constant Field Values
  - PROP_VERSION
```
public static final java.lang.String PROP_VERSION
```
    See Also:
    
    Constant Field Values
  - PROP_STREET_ADDRESS
```
public static final java.lang.String PROP_STREET_ADDRESS
```
    See Also:
    
    Constant Field Values
  - PROP_TELEPHONE_NUMBER
```
public static final java.lang.String PROP_TELEPHONE_NUMBER
```
    See Also:
    
    Constant Field Values
  - PROP_RFC822_NAME
```
public static final java.lang.String PROP_RFC822_NAME
```
    See Also:
    
    Constant Field Values
  - PROP_ID
```
public static final java.lang.String PROP_ID
```
    See Also:
    
    Constant Field Values
  - PROP_HOSTNAME
```
public static final java.lang.String PROP_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - PROP_PORT_NUMBER
```
public static final java.lang.String PROP_PORT_NUMBER
```
    See Also:
    
    Constant Field Values
  - PROP_MAX_USERS
```
public static final java.lang.String PROP_MAX_USERS
```
    See Also:
    
    Constant Field Values
  - PROP_SERVICE_LEVEL
```
public static final java.lang.String PROP_SERVICE_LEVEL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PresenceExt
```
public PresenceExt()
```
- Method Detail
  - init
```
public void init(IPolicyProcessor owner,
                 IConfigStore config)
          throws EBaseException
```
    Description copied from class: APolicyRule
    
    Initializes the policy rule.
    
    Specified by:
    
    init in interface IPolicyRule
    
    Specified by:
    
    init in class APolicyRule
    
    config - The config store reference
    
    Throws:
    
    EBaseException
  - apply
```
public PolicyResult apply(IRequest req)
```
    Description copied from class: APolicyRule
    
    Applies the policy on the given Request.
    
    Specified by:
    
    apply in interface IPolicy
    
    Specified by:
    
    apply in interface IPolicyRule
    
    Specified by:
    
    apply in class APolicyRule
    
    Parameters:
    
    req - The request on which to apply policy.
    
    Returns:
    
    The policy result object.
  - getInstanceParams
```
public java.util.Vector<java.lang.String> getInstanceParams()
```
    Description copied from class: APolicyRule
    
    Return configured parameters for a policy rule instance.
    
    Specified by:
    
    getInstanceParams in interface IPolicyRule
    
    Specified by:
    
    getInstanceParams in class APolicyRule
    
    Returns:
    
    nvPairs A Vector of name/value pairs.
  - getExtendedPluginInfo
```
public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
```
  - getDefaultParams
```
public java.util.Vector<java.lang.String> getDefaultParams()
```
    Return default parameters for a policy implementation.
    
    Specified by:
    
    getDefaultParams in interface IPolicyRule
    
    Specified by:
    
    getDefaultParams in class APolicyRule
    
    Returns:
    
    nvPairs A Vector of name/value pairs.

Class PresenceExt

Field Summary

Fields inherited from class org.dogtagpki.legacy.server.policy.APolicyRule

Fields inherited from interface org.dogtagpki.legacy.policy.IPolicyRule

Constructor Summary

Method Summary

Methods inherited from class org.dogtagpki.legacy.server.policy.APolicyRule

Methods inherited from class java.lang.Object

Field Detail

PROP_IS_CRITICAL

PROP_OID

PROP_VERSION

PROP_STREET_ADDRESS

PROP_TELEPHONE_NUMBER

PROP_RFC822_NAME

PROP_ID

PROP_HOSTNAME

PROP_PORT_NUMBER

PROP_MAX_USERS

PROP_SERVICE_LEVEL

Constructor Detail

PresenceExt

Method Detail

init

apply

getInstanceParams

getExtendedPluginInfo

getDefaultParams