com.atlassian.crowd.embedded.api
Interface Directory

All Superinterfaces:
Attributes, Serializable
All Known Implementing Classes:
DirectoryImpl, ImmutableDirectory, ImmutableDirectory

public interface Directory
extends Serializable, Attributes

Represents a Directory configuration in Crowd. It is used to create a RemoteDirectory for want of a better name, you could really call this a Directory Configuration class.


Method Summary
 Set<OperationType> getAllowedOperations()
          Returns the operations allowed to be performed on this directory.
 Map<String,String> getAttributes()
          Returns the attributes of the directory.
 Date getCreatedDate()
          Returns the date the directory was created.
 String getDescription()
          Returns a description of the directory.
 String getEncryptionType()
          Returns the encryption algorithm used by the directory.
 Long getId()
          Returns the directory ID.
 String getImplementationClass()
          Returns the fully qualified name of the class that implements the directory.
 String getName()
          Returns the name of the directory.
 DirectoryType getType()
          Returns the type of the directory.
 Date getUpdatedDate()
          Returns the date the directory was last modified.
 boolean isActive()
          Returns true if the directory is currently active, otherwise false.
 
Methods inherited from interface com.atlassian.crowd.embedded.api.Attributes
getKeys, getValue, getValues, isEmpty
 

Method Detail

getId

Long getId()
Returns the directory ID.

Returns:
directory ID

getName

String getName()
Returns the name of the directory.

Returns:
name of the directory

isActive

boolean isActive()
Returns true if the directory is currently active, otherwise false.

Returns:
true if the directory is currently active, otherwise false.

getEncryptionType

String getEncryptionType()
Returns the encryption algorithm used by the directory.

Returns:
encryption algorithm used by the directory

getAttributes

Map<String,String> getAttributes()
Returns the attributes of the directory.

Returns:
attributes of the directory

getAllowedOperations

Set<OperationType> getAllowedOperations()
Returns the operations allowed to be performed on this directory.

Returns:
the operations allowed to be performed on this directory

getDescription

String getDescription()
Returns a description of the directory.

Returns:
description of the directory

getType

DirectoryType getType()
Returns the type of the directory.

Returns:
type of the directory
See Also:
DirectoryType

getImplementationClass

String getImplementationClass()
Returns the fully qualified name of the class that implements the directory.

Returns:
the fully qualified name of the class that implements the directory

getCreatedDate

Date getCreatedDate()
Returns the date the directory was created.

Returns:
date the directory was created

getUpdatedDate

Date getUpdatedDate()
Returns the date the directory was last modified.

Returns:
date the directory was last modified


Copyright © 2013 Atlassian. All Rights Reserved.