com.atlassian.crowd.model.application
Interface Application

All Superinterfaces:

Attributes, java.io.Serializable

All Known Implementing Classes:

ApplicationImpl, ImmutableApplication

public interface Application
extends java.io.Serializable, Attributes

An Application in Crowd. This is the top level citizen in Crowd, where an application will have an ordered set of associated Directory's which it can access.

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns the attributes of the application.
java.util.Date	getCreatedDate() Returns the date the application was created.
PasswordCredential	getCredential() Returns the application password.
java.lang.String	getDescription() Returns the description of the application.
DirectoryMapping	getDirectoryMapping(long directoryId) Returns a directory mapping of the directory specified by directory id.
java.util.List<DirectoryMapping>	getDirectoryMappings() Returns the list of directory mappings ranked by directory priority as in perspective of the application.
java.lang.Long	getId() Returns the application ID.
java.lang.String	getName() Returns the name of the application.
java.util.Set<RemoteAddress>	getRemoteAddresses() Returns the whitelist of addresses allowed to connect to Crowd as the application.
ApplicationType	getType() Returns the type of the application.
java.util.Date	getUpdatedDate() Returns the date the application was last updated.
boolean	hasRemoteAddress(java.lang.String remoteAddress) Returns true if the remote address is already in the list of allowable remote addresses for the application.
boolean	isActive() Returns whether the application is active.
boolean	isAliasingEnabled() Returns true if aliasing is enabled for the application.
boolean	isLowerCaseOutput() Returns true if the usernames and group names returned should be in lowercase.
boolean	isPermanent() Returns whether the application is a permanent application and thus cannot be removed.

Methods inherited from interface com.atlassian.crowd.embedded.api.Attributes

getKeys, getValue, getValues, isEmpty

Method Detail

getId

java.lang.Long getId()

Returns the application ID.

Returns:

application ID

getName

java.lang.String getName()

Returns the name of the application.

Returns:

name of the application

getType

ApplicationType getType()

Returns the type of the application.

Returns:

application type

getDescription

java.lang.String getDescription()

Returns the description of the application.

Returns:

description of the application

getCredential

PasswordCredential getCredential()

Returns the application password.

Returns:

application password

isPermanent

boolean isPermanent()

Returns whether the application is a permanent application and thus cannot be removed. For instance, the Crowd application is a permanent application.

Returns:

true if the application is permanent.

isActive

boolean isActive()

Returns whether the application is active.

Returns:

true if the application is active.

getAttributes

java.util.Map<java.lang.String,java.lang.String> getAttributes()

Returns the attributes of the application.

Returns:

attributes of the application

getDirectoryMappings

java.util.List<DirectoryMapping> getDirectoryMappings()

Returns the list of directory mappings ranked by directory priority as in perspective of the application.

Returns:

List of directory mappings (never null).

getDirectoryMapping

DirectoryMapping getDirectoryMapping(long directoryId)

Returns a directory mapping of the directory specified by directory id.

Parameters:

directoryId - ID of the directory

Returns:

directory mapping if found, null if the directory mapping could not be found

getRemoteAddresses

java.util.Set<RemoteAddress> getRemoteAddresses()

Returns the whitelist of addresses allowed to connect to Crowd as the application. The remote addresses may contain subnet masking information in CIDR format.

Returns:

whitelist of addresses allowed to connect to Crowd as the application.

hasRemoteAddress

boolean hasRemoteAddress(java.lang.String remoteAddress)

Returns true if the remote address is already in the list of allowable remote addresses for the application.

Parameters:

remoteAddress - RemoteAddress whose presence is to be tested

Returns:

true if the remote address is already in the list of allowable remote addresses for the application

isLowerCaseOutput

boolean isLowerCaseOutput()

Returns true if the usernames and group names returned should be in lowercase.

Returns:

true if the usernames and group names returned

isAliasingEnabled

boolean isAliasingEnabled()

Returns true if aliasing is enabled for the application.

Returns:

true if aliasing is enabled for the application

getCreatedDate

java.util.Date getCreatedDate()

Returns the date the application was created.

Returns:

date the application was created

getUpdatedDate

java.util.Date getUpdatedDate()

Returns the date the application was last updated. If the application has just been created, the updated date will be the same as the creation date.

Returns:

date the application was last updated