Skip navigation links
Oracle® Database Real Application Security Java API Reference
Release 19c

E96300-01
A C D E G I N O P R S T U V X 

A

abortSession(Session) - Method in class oracle.security.xs.XSSessionManager
Detaches this session.
AccessDeniedException - Exception in oracle.security.xs
Exception thrown when an operation fails due to insufficient privilege.
AccessDeniedException(Throwable) - Constructor for exception oracle.security.xs.AccessDeniedException
 
AccessDeniedException(String) - Constructor for exception oracle.security.xs.AccessDeniedException
 
AccessDeniedException() - Constructor for exception oracle.security.xs.AccessDeniedException
 
AclId - Class in oracle.security.xs
This class represents multiple ACL IDs in either long or raw form.
AclId(byte[]) - Constructor for class oracle.security.xs.AclId
Constructs an AclId using the raw binary returned by the ora_get_aclids operator.
AclId(List<Long>) - Constructor for class oracle.security.xs.AclId
Constructs an AclId with internal ACL IDs of type long.
assignUser(Session, String, Collection<String>, Collection<String>, Collection<NamespaceValue>, Timestamp) - Method in class oracle.security.xs.XSSessionManager
Assigns an XS user to the session that was previously created for anonymous user.
assignUser(Session, ExternalUser, Collection<String>, Collection<String>, Collection<ExternalRole>, Collection<NamespaceValue>, Timestamp) - Method in class oracle.security.xs.XSSessionManager
Assigns an external user to the session that was previously created for anonymous user.
attachSession(Connection, Session, Collection<String>, Collection<String>, Collection<ExternalRole>, Collection<NamespaceValue>, Timestamp) - Method in class oracle.security.xs.XSSessionManager
Attaches the JDBC connection to the specified XS user's session.
attachSession(Connection, Session, Collection<String>, Collection<String>, Collection<NamespaceValue>, Timestamp) - Method in class oracle.security.xs.XSSessionManager
Attaches the JDBC connection to the specified XS user's session.
attachSessionByCookie(Connection, String, Collection<String>, Collection<String>, Collection<ExternalRole>, Collection<NamespaceValue>, Timestamp) - Method in class oracle.security.xs.XSSessionManager
Attaches the corresponding session for a specified cookie and returns the Session object.
attachSessionByID(Connection, String, Collection<String>, Collection<String>, Collection<ExternalRole>, Collection<NamespaceValue>, Timestamp) - Method in class oracle.security.xs.XSSessionManager
Attaches the corresponding session for a specified ID and returns the Session object.
AttributeValue - Class in oracle.security.xs
This class provides a name/value pair that is stored in session namespace.
AttributeValue(String, String) - Constructor for class oracle.security.xs.AttributeValue
Creates an AttibuteValue with the specified attribute name and attribute value.
authenticate(String, String, String) - Static method in class oracle.security.xs.XSAuthenticationModule
Authenticates the user against the Database.

C

checkAcl(Session, AclId, List<String>) - Static method in class oracle.security.xs.XSAccessController
Checks for mutiple privileges.
checkAcl(Session, AclId, String) - Static method in class oracle.security.xs.XSAccessController
Checks for a privilege.
checkAcl(Session, byte[], List<String>) - Static method in class oracle.security.xs.XSAccessController
Checks for multiple privileges.
checkAcl(Session, byte[], String) - Static method in class oracle.security.xs.XSAccessController
Checks for a privilege.
clearCache() - Method in class oracle.security.xs.XSSessionManager
Explicitly clears the shared cache from the middle tier.
createAnonymousSession(Connection, String, Collection<NamespaceValue>) - Method in class oracle.security.xs.XSSessionManager
Creates an anonymous Session for XS user (to be assigned to) on the server as well as its corresponding middle-tier representation.
createAnonymousSessionTrusted(Connection, String, Collection<NamespaceValue>) - Method in class oracle.security.xs.XSSessionManager
Creates an anonymous Session in trusted mode on the server for external user (to be assigned to) as well as its corresponding middle-tier representation.
createAttribute(String, String) - Method in interface oracle.security.xs.SessionNamespace
Creates a new attribute in the namespace with the specified name and value.
createAttribute(String, String, List<SessionNamespace.ATTR_EVENT_TYPE>) - Method in interface oracle.security.xs.SessionNamespace
Creates a new attribute in the namespace with the specified name, value, and event.
createAttribute(SessionNamespace, String, String, List<SessionNamespace.ATTR_EVENT_TYPE>) - Method in class oracle.security.xs.XSSessionManager
Creates a new attribute in the namespace with the specified name, value, and event.
createNamespace(String) - Method in interface oracle.security.xs.Session
Creates a new namespace for this session.
createNamespace(Session, String) - Method in class oracle.security.xs.XSSessionManager
Creates a new namespace for the given session.
createSession(Connection, String, String, Collection<NamespaceValue>) - Method in class oracle.security.xs.XSSessionManager
Creates a Session object on the server as well as its corresponding midtier representation.
createSession(Connection, ExternalUser, String, Collection<NamespaceValue>) - Method in class oracle.security.xs.XSSessionManager
Creates a Session object for specified external user on the server as well as its corresponding middle-tier representation.
createSessionTrusted(Connection, ExternalUser, String, Collection<NamespaceValue>) - Method in class oracle.security.xs.XSSessionManager
Creates a Session object for specified external user in trusted mode on the server as well as its corresponding middle-tier representation.

D

deleteAttribute(String) - Method in interface oracle.security.xs.SessionNamespace
Deletes the specified attribute
deleteAttribute(SessionNamespace, String) - Method in class oracle.security.xs.XSSessionManager
Deletes the specified attribute The dispatcher needs to have the privilege to delete the given attribute
deleteNamespace(String) - Method in interface oracle.security.xs.Session
Removes a namespace from a session.
deleteNamespace(Session, String) - Method in class oracle.security.xs.XSSessionManager
Removes a namespace from the session.
destroySession(Connection, Session) - Method in class oracle.security.xs.XSSessionManager
Destroys the XS session.
detachSession(Session) - Method in class oracle.security.xs.XSSessionManager
Detaches this session.
disableRole(Role) - Method in interface oracle.security.xs.Session
Disables a role granted to the current user for this session.

E

enableRole(Role) - Method in interface oracle.security.xs.Session
Enables a role granted to the current user for this session.
ExternalRole - Class in oracle.security.xs
This class represents externally managed roles used in a session.
ExternalRole(String, String, long) - Constructor for class oracle.security.xs.ExternalRole
Constructs an ExternalRole object from a name, a UUID, and a DBID.
ExternalRole(String, String) - Constructor for class oracle.security.xs.ExternalRole
Constructs an ExternalRole object from a name and a UUID
ExternalRole(String) - Constructor for class oracle.security.xs.ExternalRole
Constructs an ExternalRole object from a UUID
ExternalUser - Class in oracle.security.xs
This class represents externally managed users used in a session.
ExternalUser(String, String, long) - Constructor for class oracle.security.xs.ExternalUser
Constructs an ExternalUser object from a name, a UUID and a DBID.
ExternalUser(String, String) - Constructor for class oracle.security.xs.ExternalUser
Constructs an ExternalUser object from a name and a UUID
ExternalUser(String) - Constructor for class oracle.security.xs.ExternalUser
Constructs an ExternalUser object from a name

G

getAttribute(String) - Method in interface oracle.security.xs.SessionNamespace
" Returns the specified attribute."
getAttributes() - Method in class oracle.security.xs.NamespaceValue
Retrieves the list of attributes.
getAttributes() - Method in interface oracle.security.xs.SessionNamespace
Returns a collection of the attribute names in the namespace.
getCacheMaxIdleTime() - Method in class oracle.security.xs.XSSessionManager
Returns the maximum number of minutes for which the cache can remain without any activity
getCacheMaxSize() - Method in class oracle.security.xs.XSSessionManager
Returns the maximum cache size, in bytes.
getConnection() - Method in interface oracle.security.xs.Session
Returns the Oracle JDBC Connection attached with this session.
getCookie() - Method in interface oracle.security.xs.Session
Returns the secure session cookie used for this session.
getDBID() - Method in class oracle.security.xs.Principal
Retrieves the DBID of the Principal.
getDefaultValue() - Method in interface oracle.security.xs.SessionNamespaceAttribute
Returns the default value of the attribute
getEnabledRoles() - Method in interface oracle.security.xs.Session
Returns a collection of all currently enabled roles.
getHighWaterMark() - Method in class oracle.security.xs.XSSessionManager
Gets the high watermark for the cache.
getId() - Method in interface oracle.security.xs.Session
Returns the internal session ID generated at server for this session.
getIds() - Method in class oracle.security.xs.AclId
Returns internal ACL IDs of type long.
getLowWaterMark() - Method in class oracle.security.xs.XSSessionManager
Gets the low watermark for the cache.
getMessage() - Method in exception oracle.security.xs.XSException
Returns the detailed message of the exception.
getMessage(Locale) - Method in exception oracle.security.xs.XSException
Returns the detailed message of the exception in the specified Locale.
getName() - Method in class oracle.security.xs.AttributeValue
Returns the attribute name.
getName() - Method in class oracle.security.xs.Principal
Retrieves the name of the Principal.
getName() - Method in interface oracle.security.xs.SessionNamespace
Returns the name of the namespace
getName() - Method in interface oracle.security.xs.SessionNamespaceAttribute
Returns the attribute name.
getNamespace() - Method in class oracle.security.xs.NamespaceValue
Retrieves the namespace name.
getNamespace(String) - Method in interface oracle.security.xs.Session
Returns the specified namespace in the session.
getPrivateCacheMaxEntries() - Method in class oracle.security.xs.XSSessionManager
Returns the maximum number of entries that the ACL evaluation result can be cached in the session.
getPrivileges(Session, AclId) - Static method in class oracle.security.xs.XSAccessController
Returns a collection of privileges, which is granted in the specified ACL (AclId), based on the specified session.
getPrivileges(Session, byte[]) - Static method in class oracle.security.xs.XSAccessController
Returns a collection of privileges, which is granted in the specified ACL (byte[]), based on the specified session.
getSessionManager(DataSource, int, int) - Static method in class oracle.security.xs.XSSessionManager
Initializes an XSSessionManager using connections from the connection pool.
getSessionManager(Connection, int, int) - Static method in class oracle.security.xs.XSSessionManager
Initializes an XSSessionManager using a dedicated connections.
getUser() - Method in interface oracle.security.xs.Session
Returns current session's user
getUUID() - Method in class oracle.security.xs.Principal
Retrieves the UUID of the Principal.
getValue() - Method in class oracle.security.xs.AttributeValue
Returns the attribute value.
getValue() - Method in interface oracle.security.xs.SessionNamespaceAttribute
Returns the attribute value.

I

InvalidSessionException - Exception in oracle.security.xs
Exception thrown on any session operations when the session is not valid.
InvalidSessionException() - Constructor for exception oracle.security.xs.InvalidSessionException
 
InvalidSessionException(String) - Constructor for exception oracle.security.xs.InvalidSessionException
 
InvalidSessionException(Throwable) - Constructor for exception oracle.security.xs.InvalidSessionException
 
InvalidSessionException(String, Throwable) - Constructor for exception oracle.security.xs.InvalidSessionException
 
InvalidXSAttributeException - Exception in oracle.security.xs
Exception thrown after an attempt to reference an invalid namespace attribute.
InvalidXSAttributeException() - Constructor for exception oracle.security.xs.InvalidXSAttributeException
 
InvalidXSAttributeException(String) - Constructor for exception oracle.security.xs.InvalidXSAttributeException
 
InvalidXSNamespaceException - Exception in oracle.security.xs
Exception thrown after an attempt is made to reference an invalid namespace.
InvalidXSNamespaceException() - Constructor for exception oracle.security.xs.InvalidXSNamespaceException
 
InvalidXSNamespaceException(String) - Constructor for exception oracle.security.xs.InvalidXSNamespaceException
 
InvalidXSUserException - Exception in oracle.security.xs
Exception thrown in any session operations when the specified user is invalid.
InvalidXSUserException() - Constructor for exception oracle.security.xs.InvalidXSUserException
 
InvalidXSUserException(String) - Constructor for exception oracle.security.xs.InvalidXSUserException
 
InvalidXSUserException(Throwable) - Constructor for exception oracle.security.xs.InvalidXSUserException
 
isAnonymous() - Method in class oracle.security.xs.ExternalUser
Indicates if the current user is anonymous.
isAnonymous() - Method in interface oracle.security.xs.Session
Determines if this session user is anonymous.
isAttached() - Method in interface oracle.security.xs.Session
Determines if this session is attached to a Connection.
isRoleEnabled(String) - Method in interface oracle.security.xs.Session
Tests if the specified role is enabled in this user's session.
isTrusted() - Method in interface oracle.security.xs.Session
Determins if the current session is in trusted mode.

N

NamespaceValue - Class in oracle.security.xs
This class represents a namespace and its attributes, which are used in session namespace operations.
NamespaceValue(String, Collection<AttributeValue>) - Constructor for class oracle.security.xs.NamespaceValue
Creates a namespace with the specified name and attributes.
NotAttachedException - Exception in oracle.security.xs
Exception thrown if a session operation is called without being attached.
NotAttachedException() - Constructor for exception oracle.security.xs.NotAttachedException
Constructs a new NotAttachException.
NotAttachedException(String) - Constructor for exception oracle.security.xs.NotAttachedException
Constructs a new NotAttachException.

O

oracle.security.xs - package oracle.security.xs
Provides classes to access Fusion Security functions from java Middle Tier.

P

Principal - Class in oracle.security.xs
This class represents a Principal entity, such as a Role or a User.
Principal() - Constructor for class oracle.security.xs.Principal
Constructs a new Principal.
Principal(String) - Constructor for class oracle.security.xs.Principal
Constructs a new Principal with the specified name.

R

resetAttribute(String) - Method in interface oracle.security.xs.SessionNamespace
Resets the specified attribute in the namespace to its default value.
resetAttribute(SessionNamespace, String) - Method in class oracle.security.xs.XSSessionManager
Resets the specified attribute in the namespace to its default value.
Role - Class in oracle.security.xs
This class represents a type of principal that can be associated with a group of users.
Role() - Constructor for class oracle.security.xs.Role
Constructs a Role object.
Role(String, String, long) - Constructor for class oracle.security.xs.Role
Constructs an Role object from a name, a UUID and a DBID.
Role(String, String) - Constructor for class oracle.security.xs.Role
Constructs an Role object from a name and a UUID.
Role(String, long) - Constructor for class oracle.security.xs.Role
Constructs an Role object from a name and a DBID.

S

saveSession(Session) - Method in class oracle.security.xs.XSSessionManager
Saves the specified session leaving it attached.
Session - Interface in oracle.security.xs
This interface represents an application security context that encapsulates user, role, and namespace.
SessionNamespace - Interface in oracle.security.xs
This interface represents a set of name/value (SessionNamespaceAttibute) pairs associated with Session, which are commonly used to record application state, user profile, and so on.
SessionNamespace.ATTR_EVENT_TYPE - Enum in oracle.security.xs
The list of possible events an attribute can have.
SessionNamespaceAttribute - Interface in oracle.security.xs
This interface represents a name/value pair that is stored as an attribute in the session namespace ( SessionNamespace ).
SessionNamespaceException - Exception in oracle.security.xs
Exception thrown when a generic error happens on namespace operation.
SessionNamespaceException(String) - Constructor for exception oracle.security.xs.SessionNamespaceException
 
setAttribute(String, String) - Method in interface oracle.security.xs.SessionNamespace
Sets the attribute for a session namespace with the specified name and value
setAttribute(SessionNamespace, String, String) - Method in class oracle.security.xs.XSSessionManager
Sets the attribute for a session namespace with the specified name and value The dispatcher needs to have the privilege to set the attribute on the given namespace
setAttributes(List<AttributeValue>) - Method in class oracle.security.xs.NamespaceValue
Sets the list of attributes
setCacheMaxIdleTime(int) - Method in class oracle.security.xs.XSSessionManager
Sets the maximum number of minutes for which the cache can remain without any activity.
setCacheMaxSize(long) - Method in class oracle.security.xs.XSSessionManager
Sets the size of the cache on the middle tier, in bytes.
setCookie(Session, String) - Method in class oracle.security.xs.XSSessionManager
Sets the cookie for the session
setInactivityTimeout(Session, int) - Method in class oracle.security.xs.XSSessionManager
Sets the inactivity timeout for the session in minutes.
setNamespace(String) - Method in class oracle.security.xs.NamespaceValue
set namespace name
setPrivateCacheMaxEntries(int) - Method in class oracle.security.xs.XSSessionManager
Sets the maximum number of entries that the ACL evaluation result can be cached in the session.
setValue(String) - Method in class oracle.security.xs.AttributeValue
Sets the attribute value
setWaterMark(float, float) - Method in class oracle.security.xs.XSSessionManager
Sets the high and low watermarks for the cache.
switchUser(String, Collection<NamespaceValue>) - Method in interface oracle.security.xs.Session
Changes the session user.
switchUserKeepState(String, Collection<NamespaceValue>) - Method in interface oracle.security.xs.Session
Changes the session user and retains session state (Namespace).

T

toString() - Method in class oracle.security.xs.AttributeValue
 
toString() - Method in class oracle.security.xs.NamespaceValue
 
toString() - Method in class oracle.security.xs.Principal
Returns a string representation of the Principal.
toString() - Method in interface oracle.security.xs.Session
 
toString() - Method in interface oracle.security.xs.SessionNamespace
Returns a string representation of the namespace
toString() - Method in interface oracle.security.xs.SessionNamespaceAttribute
Returns a string representation of the SessionNamespaceAttribute.
toString() - Method in exception oracle.security.xs.XSSessionManagerException
Returns a string representation of the XSSessionManagerException.

U

User - Class in oracle.security.xs
This class represents a user, which is a type of principal.
User() - Constructor for class oracle.security.xs.User
Constructs a User object.
User(String) - Constructor for class oracle.security.xs.User
Constructs a User object with the specified name.
User(String, String, long) - Constructor for class oracle.security.xs.User
Constructs a User object with the specified name, UUID and DBID.
User(String, String) - Constructor for class oracle.security.xs.User
Constructs a User object with the specified name and UUID.

V

validate() - Method in class oracle.security.xs.Principal
Tests whether the object is valid or not.
valueOf(String) - Static method in enum oracle.security.xs.SessionNamespace.ATTR_EVENT_TYPE
Returns the enum constant of this type with the specified name.
values() - Static method in enum oracle.security.xs.SessionNamespace.ATTR_EVENT_TYPE
Returns an array containing the constants of this enum type, in the order they are declared.
verify(String, String, long) - Method in class oracle.security.xs.Principal
Tests whether the object is the same as specified

X

XSAccessController - Class in oracle.security.xs
This class provides authorization functions to check the privilege on the ACL based on the session.
XSAccessController() - Constructor for class oracle.security.xs.XSAccessController
 
XSAuthenticationModule - Class in oracle.security.xs
This class provides authentication functions to verify the user credentials against the Database.
XSAuthenticationModule() - Constructor for class oracle.security.xs.XSAuthenticationModule
 
XSException - Exception in oracle.security.xs
Base exception class and a wrapper for server-side error.
XSException() - Constructor for exception oracle.security.xs.XSException
Creates a new XSException.
XSException(String) - Constructor for exception oracle.security.xs.XSException
Creates a new XSException with the specified exception message.
XSException(Throwable) - Constructor for exception oracle.security.xs.XSException
Creates a new XSException with the specified cause of the exception.
XSException(String, Throwable) - Constructor for exception oracle.security.xs.XSException
Creates a new XSException with the specified exception message and cause of exception.
XSException(String, Object[], Throwable) - Constructor for exception oracle.security.xs.XSException
Creates a new XSException with the specified error key, parameters, and cause of error.
XSException(String, Object[]) - Constructor for exception oracle.security.xs.XSException
Creates a new XSException with the specified error key and parameters.
XSPrincipalException - Exception in oracle.security.xs
Exception thrown when creating a principal object with invalid values.
XSPrincipalException(String) - Constructor for exception oracle.security.xs.XSPrincipalException
 
XSPrincipalException(Throwable) - Constructor for exception oracle.security.xs.XSPrincipalException
 
XSSecurityPermission - Class in oracle.security.xs
This class represents a Java permission that extends the BasicPermission class to authorize the execution of critical XS methods in the oracle.security.xs package.
XSSecurityPermission(String) - Constructor for class oracle.security.xs.XSSecurityPermission
Constructs a new XSSecurityPermission from the specified name.
XSSessionException - Exception in oracle.security.xs
 
XSSessionException() - Constructor for exception oracle.security.xs.XSSessionException
 
XSSessionManager - Class in oracle.security.xs
This class provides functions to manage the Session, inlcude session life cycle (createSession, attachSession, detachSessiona and destroySession), session attribute (cookie, inactivity timeout) and session namespace.
XSSessionManager() - Constructor for class oracle.security.xs.XSSessionManager
 
XSSessionManagerException - Exception in oracle.security.xs
Exception thrown when the session manager is not working.
XSSessionManagerException(String) - Constructor for exception oracle.security.xs.XSSessionManagerException
Creates a new XSSessionManagerException with the specified exception message.
A C D E G I N O P R S T U V X 
Skip navigation links
Oracle® Database Real Application Security Java API Reference
Release 19c

E96300-01

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Copyright © 2016, 2019, Oracle and/or its affiliates. All rights reserved.