edu.internet2.middleware.ldappc
Class LdappcOptions

java.lang.Object
  extended by edu.internet2.middleware.ldappc.LdappcOptions

public class LdappcOptions
extends Object

Class for processing command line input arguments, to verify them, and to make them or values calculated from them available to the rest of the code.


Nested Class Summary
static class LdappcOptions.ProvisioningMode
          Modes of operation.
 
Field Summary
static String ATTRIBUTE_AUTHORITY_NAME
          The name of the Attribute Authority service.
static String ATTRIBUTE_RESOLVER_FILE_NAME_INTERNAL
          The name of the "internal" Spring configuration file for the Attribute Resolver.
static String ATTRIBUTE_RESOLVER_FILE_NAME_SERVICES
          The name of the "services" Spring configuration file for the Attribute Resolver.
static String ATTRIBUTE_RESOLVER_NAME
          The name of the Attribute Resolver service.
 
Constructor Summary
LdappcOptions()
           
LdappcOptions(String[] args)
          The Constructor for input processing of command line options.
 
Method Summary
 String getAttributeResolverLocation()
          The path to the Attribute Resolver configuration files.
 String getConfigManagerLocation()
          Get the location of the alternative configuration manager.
 boolean getDoGroups()
          This returns a boolean indicating whether or not groups are provisioned.
 boolean getDoMemberships()
          This returns a boolean indicating whether or not memberships are provisioned.
 int getInterval()
          This is the getter for interval.
 Date getLastModifyTime()
          This returns the last modify time.
 boolean getLogLdif()
          This returns a boolean indicating whether or not to log changes in LDIF format.
 LdappcOptions.ProvisioningMode getMode()
          The mode of operation.
 String getOutputFileLocation()
          The path to the file written during calculate mode.
 String getPropertiesFileLocation()
          The path to the properties file.
 String getSubjectId()
          Returns the Subject ID used to select data for provisioning.
 void init(String[] args)
          This initializer verifies the input arguments and makes them accessible through the use of getter methods.
 boolean isTest()
           
 void printUsage()
           
protected  void setAttributeResolverLocation(String attributeResolverLocation)
           
protected  void setConfigManagerLocation(String configManagerLocation)
           
protected  void setDoGroups(boolean doGroups)
           
protected  void setDoMemberships(boolean doMemberships)
           
protected  void setInterval(int interval)
           
 void setIsTest(boolean isTest)
           
 void setLastModifyTime(Date lastModifyTime)
           
protected  void setLogLdif(boolean logLdif)
           
protected  void setMode(LdappcOptions.ProvisioningMode mode)
           
protected  void setOutputFileLocation(String outputFileLocation)
           
 void setPropertiesFileLocation(String propertiesFileLocation)
           
protected  void setSubjectId(String subjectId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTRIBUTE_RESOLVER_FILE_NAME_INTERNAL

public static final String ATTRIBUTE_RESOLVER_FILE_NAME_INTERNAL
The name of the "internal" Spring configuration file for the Attribute Resolver.

See Also:
Constant Field Values

ATTRIBUTE_RESOLVER_FILE_NAME_SERVICES

public static final String ATTRIBUTE_RESOLVER_FILE_NAME_SERVICES
The name of the "services" Spring configuration file for the Attribute Resolver.

See Also:
Constant Field Values

ATTRIBUTE_AUTHORITY_NAME

public static final String ATTRIBUTE_AUTHORITY_NAME
The name of the Attribute Authority service.

See Also:
Constant Field Values

ATTRIBUTE_RESOLVER_NAME

public static final String ATTRIBUTE_RESOLVER_NAME
The name of the Attribute Resolver service.

See Also:
Constant Field Values
Constructor Detail

LdappcOptions

public LdappcOptions()

LdappcOptions

public LdappcOptions(String[] args)
              throws org.apache.commons.cli.ParseException,
                     ParseException
The Constructor for input processing of command line options.

Parameters:
args - Command line arguments to parse.
Throws:
org.apache.commons.cli.ParseException
ParseException
Method Detail

init

public void init(String[] args)
          throws org.apache.commons.cli.ParseException,
                 ParseException
This initializer verifies the input arguments and makes them accessible through the use of getter methods.

Parameters:
args -
Throws:
org.apache.commons.cli.ParseException
ParseException

setIsTest

public void setIsTest(boolean isTest)

isTest

public boolean isTest()

setSubjectId

protected void setSubjectId(String subjectId)

getSubjectId

public String getSubjectId()
Returns the Subject ID used to select data for provisioning.

Returns:
The current value of subjectId.

setDoGroups

protected void setDoGroups(boolean doGroups)

getDoGroups

public boolean getDoGroups()
This returns a boolean indicating whether or not groups are provisioned.

Returns:
true if groups are to be provisioned and false otherwise.

setDoMemberships

protected void setDoMemberships(boolean doMemberships)

getDoMemberships

public boolean getDoMemberships()
This returns a boolean indicating whether or not memberships are provisioned.

Returns:
true if memberships are to be provisioned and false otherwise.

setLastModifyTime

public void setLastModifyTime(Date lastModifyTime)

getLastModifyTime

public Date getLastModifyTime()
This returns the last modify time.

Returns:
Last modify time or null if not defined.

setInterval

protected void setInterval(int interval)

getInterval

public int getInterval()
This is the getter for interval.

Returns:
The current value of interval.

setConfigManagerLocation

protected void setConfigManagerLocation(String configManagerLocation)

getConfigManagerLocation

public String getConfigManagerLocation()
Get the location of the alternative configuration manager.

Returns:
URI of the alternative configuration XML file.

printUsage

public void printUsage()

getMode

public LdappcOptions.ProvisioningMode getMode()
The mode of operation.

Returns:
mode

setMode

protected void setMode(LdappcOptions.ProvisioningMode mode)

getOutputFileLocation

public String getOutputFileLocation()
The path to the file written during calculate mode.

Returns:
the path

setOutputFileLocation

protected void setOutputFileLocation(String outputFileLocation)

getPropertiesFileLocation

public String getPropertiesFileLocation()
The path to the properties file.

Returns:

setPropertiesFileLocation

public void setPropertiesFileLocation(String propertiesFileLocation)

setLogLdif

protected void setLogLdif(boolean logLdif)

getLogLdif

public boolean getLogLdif()
This returns a boolean indicating whether or not to log changes in LDIF format.

Returns:
true if log LDIF changes false otherwise.

getAttributeResolverLocation

public String getAttributeResolverLocation()
The path to the Attribute Resolver configuration files.

Returns:

setAttributeResolverLocation

protected void setAttributeResolverLocation(String attributeResolverLocation)


Copyright © 2011 Internet2. All Rights Reserved.