ccc.api.core
Interface Security

All Known Implementing Classes:

SecurityImpl, SecurityImpl2

public interface Security

Security API for CCC.

Author:

Civic Computing Ltd.

Field Summary

static java.lang.String	COLLECTION COLLECTION : String.
static java.lang.String	CURRENT CURRENT : String.
static java.lang.String	PROPERTIES PROPERTIES : String.

Method Summary

java.lang.Boolean	isLoggedIn() Determine if a user is associated with the current session.
java.lang.Boolean	login(java.lang.String username, java.lang.String password) Log in to CCC.
void	logout() Log out from the current session.
java.lang.String	readAllProperties() Read the properties for the session.

Field Detail

CURRENT

static final java.lang.String CURRENT

CURRENT : String.

See Also:

Constant Field Values

COLLECTION

static final java.lang.String COLLECTION

COLLECTION : String.

See Also:

Constant Field Values

PROPERTIES

static final java.lang.String PROPERTIES

PROPERTIES : String.

See Also:

Constant Field Values

Method Detail

login

java.lang.Boolean login(java.lang.String username,
                        java.lang.String password)

Log in to CCC.

Parameters:

username - The user's username.

password - The user's password.

Returns:

True if the login fails, false otherwise.

isLoggedIn

java.lang.Boolean isLoggedIn()

Determine if a user is associated with the current session.

Returns:

True if a user is associated, false otherwise.

logout

void logout()

Log out from the current session.

readAllProperties

java.lang.String readAllProperties()

Read the properties for the session.

Returns:

The properties as a string.