com.orientechnologies.orient.core.security

Interface OSecuritySystem

All Known Subinterfaces:

OServerSecurity

All Known Implementing Classes:

ODefaultServerSecurity

public interface OSecuritySystem

Provides a basic interface for a modular security system.

Author:

S. Colin Leister

Method Summary

Modifier and Type	Method and Description
boolean	arePasswordsStored()
String	authenticate(String username, String password)
String	getAuthenticationHeader(String databaseName)
default Map<String,String>	getAuthenticationHeaders(String databaseName)
ODocument	getComponentConfig(String name)
ODocument	getConfig()
OUser	getSystemUser(String username, String dbName) Returns the "System User" associated with 'username' from the system database.
boolean	isAuthorized(String username, String resource)
boolean	isDefaultAllowed()
boolean	isEnabled()
boolean	isSingleSignOnSupported()
void	log(OAuditingOperation operation, String dbName, OSecurityUser user, String message) Logs to the auditing service, if installed.
void	registerSecurityClass(Class<?> cls)
void	reload(ODocument jsonConfig)
default void	reload(OSecurityUser user, ODocument jsonConfig)
default void	reload(OSecurityUser user, String jsonConfig)
void	reload(String cfgPath)
void	reloadComponent(OSecurityUser user, String name, ODocument jsonConfig)
void	securityRecordChange(String dbURL, ODocument record) Called each time one of the security classes (OUser, ORole, OServerRole) is modified.
void	shutdown()
void	unregisterSecurityClass(Class<?> cls)
void	validatePassword(String username, String password)

Method Detail

shutdown

void shutdown()

isDefaultAllowed

boolean isDefaultAllowed()

authenticate

String authenticate(String username,
                    String password)

getAuthenticationHeader

String getAuthenticationHeader(String databaseName)

getAuthenticationHeaders

default Map<String,String> getAuthenticationHeaders(String databaseName)

getConfig

ODocument getConfig()

getComponentConfig

ODocument getComponentConfig(String name)

getSystemUser

OUser getSystemUser(String username,
                    String dbName)

Returns the "System User" associated with 'username' from the system database. If not found, returns null. dbName is used to filter the assigned roles. It may be null.

isAuthorized

boolean isAuthorized(String username,
                     String resource)

isEnabled

boolean isEnabled()

arePasswordsStored

boolean arePasswordsStored()

isSingleSignOnSupported

boolean isSingleSignOnSupported()

log

void log(OAuditingOperation operation,
         String dbName,
         OSecurityUser user,
         String message)

Logs to the auditing service, if installed.

Parameters:

dbName - May be null or empty.

user - May be null or empty.

registerSecurityClass

void registerSecurityClass(Class<?> cls)

reload

void reload(String cfgPath)

reload

void reload(ODocument jsonConfig)

reload

default void reload(OSecurityUser user,
                    ODocument jsonConfig)

reload

default void reload(OSecurityUser user,
                    String jsonConfig)

reloadComponent

void reloadComponent(OSecurityUser user,
                     String name,
                     ODocument jsonConfig)

securityRecordChange

void securityRecordChange(String dbURL,
                          ODocument record)

Called each time one of the security classes (OUser, ORole, OServerRole) is modified.

unregisterSecurityClass

void unregisterSecurityClass(Class<?> cls)

validatePassword

void validatePassword(String username,
                      String password)
               throws OInvalidPasswordException

Throws:

OInvalidPasswordException