com.atlassian.crowd.importer.config
Class CsvConfiguration

java.lang.Object
  com.atlassian.crowd.importer.config.Configuration
      com.atlassian.crowd.importer.config.CsvConfiguration

All Implemented Interfaces:

java.io.Serializable

public class CsvConfiguration
extends Configuration
implements java.io.Serializable

This configuration type will encapsulate all required elements to import users/groups and their memberships into Crowd from two CSV files

See Also:

Serialized Form

Field Summary

static java.lang.String	GROUP_NAME
static java.lang.String	GROUP_NONE
static java.lang.String	GROUP_PREFIX
static java.lang.String	GROUP_USERNAME
static java.lang.String	USER_EMAILADDRESS
static java.lang.String	USER_FIRSTNAME
static java.lang.String	USER_LASTNAME
static java.lang.String	USER_NONE
static java.lang.String	USER_PASSWORD
static java.lang.String	USER_PREFIX
static java.lang.String	USER_USERNAME

Fields inherited from class com.atlassian.crowd.importer.config.Configuration

overwriteTarget

Constructor Summary

CsvConfiguration()

CsvConfiguration(java.lang.Long directoryID, java.lang.String application, java.lang.Boolean importPasswords, java.io.File users, java.io.File groupMemberships, java.lang.Character delimiter, java.lang.Boolean encryptPasswords)

Method Summary

protected void	buildSampleGroupMapping(java.io.File csvDataFile)
protected void	buildSampleUserMapping(java.io.File csvDataFile)
java.lang.Character	getDelimiter()
java.util.List	getGroupHeaderRow()
org.apache.commons.collections.OrderedBidiMap	getGroupMappingConfiguration()
java.io.File	getGroupMemberships()
java.util.List	getGroupSampleRow()
java.util.List	getUserHeaderRow()
org.apache.commons.collections.OrderedBidiMap	getUserMappingConfiguration()
java.io.File	getUsers()
java.util.List	getUserSampleRow()
java.lang.Boolean	isEncryptPasswords()
void	isValid() Will make sure that all required properties have been set on the Configuration object to perform an import.
void	setDelimiter(java.lang.Character delimiter)
void	setEncryptPasswords(java.lang.Boolean encryptPasswords)
void	setGroupMappingConfiguration(org.apache.commons.collections.OrderedBidiMap groupMappingConfiguration)
void	setGroupMemberships(java.io.File groupMemberships)
void	setUserMappingConfiguration(org.apache.commons.collections.OrderedBidiMap userMappingConfiguration)
void	setUsers(java.io.File users)

Methods inherited from class com.atlassian.crowd.importer.config.Configuration

equals, getApplication, getDirectoryID, hashCode, isImportPasswords, isOverwriteTarget, setApplication, setDirectoryID, setImportPasswords, setOverwriteTarget, toString

Methods inherited from class java.lang.Object

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

Field Detail

USER_PREFIX

public static final java.lang.String USER_PREFIX

See Also:

Constant Field Values

USER_FIRSTNAME

public static final java.lang.String USER_FIRSTNAME

See Also:

Constant Field Values

USER_LASTNAME

public static final java.lang.String USER_LASTNAME

See Also:

Constant Field Values

USER_EMAILADDRESS

public static final java.lang.String USER_EMAILADDRESS

See Also:

Constant Field Values

USER_USERNAME

public static final java.lang.String USER_USERNAME

See Also:

Constant Field Values

USER_PASSWORD

public static final java.lang.String USER_PASSWORD

See Also:

Constant Field Values

USER_NONE

public static final java.lang.String USER_NONE

See Also:

Constant Field Values

GROUP_PREFIX

public static final java.lang.String GROUP_PREFIX

See Also:

Constant Field Values

GROUP_NAME

public static final java.lang.String GROUP_NAME

See Also:

Constant Field Values

GROUP_USERNAME

public static final java.lang.String GROUP_USERNAME

See Also:

Constant Field Values

GROUP_NONE

public static final java.lang.String GROUP_NONE

See Also:

Constant Field Values

Constructor Detail

CsvConfiguration

public CsvConfiguration()

CsvConfiguration

public CsvConfiguration(java.lang.Long directoryID,
                        java.lang.String application,
                        java.lang.Boolean importPasswords,
                        java.io.File users,
                        java.io.File groupMemberships,
                        java.lang.Character delimiter,
                        java.lang.Boolean encryptPasswords)

Method Detail

buildSampleUserMapping

protected void buildSampleUserMapping(java.io.File csvDataFile)

buildSampleGroupMapping

protected void buildSampleGroupMapping(java.io.File csvDataFile)

isValid

public void isValid()
             throws ImporterConfigurationException

Description copied from class: Configuration

Will make sure that all required properties have been set on the Configuration object to perform an import. Override this method if you requirs specific validation of your Configuration

Overrides:

isValid in class Configuration

Throws:

ImporterConfigurationException - if there is a problem validating the configuration

getUsers

public java.io.File getUsers()

setUsers

public void setUsers(java.io.File users)

getGroupMemberships

public java.io.File getGroupMemberships()

setGroupMemberships

public void setGroupMemberships(java.io.File groupMemberships)

getDelimiter

public java.lang.Character getDelimiter()

setDelimiter

public void setDelimiter(java.lang.Character delimiter)

isEncryptPasswords

public java.lang.Boolean isEncryptPasswords()

setEncryptPasswords

public void setEncryptPasswords(java.lang.Boolean encryptPasswords)

getUserHeaderRow

public java.util.List getUserHeaderRow()

getUserSampleRow

public java.util.List getUserSampleRow()

getGroupHeaderRow

public java.util.List getGroupHeaderRow()

getGroupSampleRow

public java.util.List getGroupSampleRow()

getUserMappingConfiguration

public org.apache.commons.collections.OrderedBidiMap getUserMappingConfiguration()

setUserMappingConfiguration

public void setUserMappingConfiguration(org.apache.commons.collections.OrderedBidiMap userMappingConfiguration)

getGroupMappingConfiguration

public org.apache.commons.collections.OrderedBidiMap getGroupMappingConfiguration()

setGroupMappingConfiguration

public void setGroupMappingConfiguration(org.apache.commons.collections.OrderedBidiMap groupMappingConfiguration)