Package com.orientechnologies.orient.core.security

Interface OSecuritySystem

All Known Implementing Classes:

ODefaultSecuritySystem

public interface OSecuritySystem

Provides a basic interface for a modular security system.

Author:

S. Colin Leister

Method Summary

Modifier and Type	Method	Description
void	addTemporaryUser(String user, String password, String resources)
boolean	arePasswordsStored()
OSecurityUser	authenticate(ODatabaseSession session, OAuthenticationInfo authenticationInfo)
OSecurityUser	authenticate(ODatabaseSession session, String username, String password)
OSecurityUser	authenticateAndAuthorize(String iUserName, String iPassword, String iResourceToCheck)
OSecurityUser	authenticateServerUser(String username, String password)
boolean	existsUser(String defaultRootUser)
OAuditingService	getAuditing()
String	getAuthenticationHeader(String databaseName)
default Map<String,String>	getAuthenticationHeaders(String databaseName)
OSecurityAuthenticator	getAuthenticator(String authName)	Returns the authenticator based on name, if one exists.
ODocument	getComponentConfig(String name)
ODocument	getConfig()
OrientDBInternal	getContext()
OSecurityAuthenticator	getPrimaryAuthenticator()	Returns the first authenticator in the list, which is the primary authenticator.
OSecurityUser	getServerUser(String username)
OSyslog	getSyslog()
OSecurityUser	getSystemUser(String username, String dbName)	Returns the "System User" associated with 'username' from the system database.
OTokenSign	getTokenSign()
OSecurityUser	getUser(String username)	Some authenticators support maintaining a list of users and associated resources (and sometimes passwords).
boolean	isAuthorized(String username, String resource)
boolean	isDefaultAllowed()
boolean	isEnabled()
boolean	isServerUserAuthorized(String username, String resource)
boolean	isSingleSignOnSupported()
void	log(OAuditingOperation operation, String dbName, OSecurityUser user, String message)	Logs to the auditing service, if installed.
OSecurityInternal	newSecurity(String database)
void	onAfterDynamicPlugins()
default void	onAfterDynamicPlugins(OSecurityUser user)
void	registerSecurityClass(Class<?> cls)
void	reload(OSecurityUser user, ODocument jsonConfig)
void	reload(OSecurityUser user, String jsonConfig)
void	reload(ODocument jsonConfig)
void	reload(String cfgPath)
void	reloadComponent(OSecurityUser user, String name, ODocument jsonConfig)
void	shutdown()
void	unregisterSecurityClass(Class<?> cls)
void	validatePassword(String username, String password)

Method Details

shutdown

void shutdown()

isDefaultAllowed

boolean isDefaultAllowed()

authenticate

OSecurityUser authenticate(ODatabaseSession session,
 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

OSecurityUser 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

void reload(OSecurityUser user,
 ODocument jsonConfig)

reload

void reload(OSecurityUser user,
 String jsonConfig)

reloadComponent

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

unregisterSecurityClass

void unregisterSecurityClass(Class<?> cls)

validatePassword

void validatePassword(String username,
 String password)
               throws OInvalidPasswordException

Throws:

OInvalidPasswordException

getAuditing

OAuditingService getAuditing()

getAuthenticator

OSecurityAuthenticator getAuthenticator(String authName)

Returns the authenticator based on name, if one exists.

getPrimaryAuthenticator

OSecurityAuthenticator getPrimaryAuthenticator()

Returns the first authenticator in the list, which is the primary authenticator.

getSyslog

OSyslog getSyslog()

getUser

OSecurityUser getUser(String username)

Some authenticators support maintaining a list of users and associated resources (and sometimes passwords).

onAfterDynamicPlugins

void onAfterDynamicPlugins()

onAfterDynamicPlugins

default void onAfterDynamicPlugins(OSecurityUser user)

authenticateAndAuthorize

OSecurityUser authenticateAndAuthorize(String iUserName,
 String iPassword,
 String iResourceToCheck)

authenticateServerUser

OSecurityUser authenticateServerUser(String username,
 String password)

getServerUser

OSecurityUser getServerUser(String username)

isServerUserAuthorized

boolean isServerUserAuthorized(String username,
 String resource)

getContext

OrientDBInternal getContext()

existsUser

boolean existsUser(String defaultRootUser)

addTemporaryUser

void addTemporaryUser(String user,
 String password,
 String resources)

newSecurity

OSecurityInternal newSecurity(String database)

authenticate

OSecurityUser authenticate(ODatabaseSession session,
 OAuthenticationInfo authenticationInfo)

getTokenSign

OTokenSign getTokenSign()