oracle.reports.server
Interface Security

public interface Security

The interface for reports server security. All security plugin needs to implement this interface

Field Summary

static java.lang.String

TNSNAME The authentication property name for the Oracle Database tns name.

Method Summary

java.lang.Object	authenticate(java.lang.String username, java.lang.String password) Authenticates a user against the default security system.
java.lang.Object	authenticate(java.lang.String username, java.lang.String password, java.util.Properties props) Authenticates a user against a target security system.
java.lang.String	getName() Returns the name of the security system.
int	getRole(java.lang.Object user) Returns the role for a given user.
void	jobCommandCheck(java.lang.Object user, Job job) Performs a security check for the job at runtime or at a scheduled time, depending on which queue the job is in.
void	start(java.util.Properties props) Starts the security system.
void	stop() Stops the security system.
void	webCommandCheck(java.lang.Object user, java.lang.String webCommand) Performs a security check for the Web command, such as showmap, showenv, etc.

Field Detail

TNSNAME

public static final java.lang.String TNSNAME

The authentication property name for the Oracle Database tns name.

Method Detail

start

public void start(java.util.Properties props)
           throws oracle.reports.RWException

Starts the security system.

Parameters:

props - Security system properties.

stop

public void stop()

Stops the security system. The system must be stopped before removing it.

authenticate

public java.lang.Object authenticate(java.lang.String username,
                                     java.lang.String password)
                              throws oracle.reports.RWException

Authenticates a user against the default security system.

Parameters:

username - User name.

password - Password for the user.

Returns:

If the authentication succeeds, an opaque user object (that only the security system understands) is returned. Otherwise, it generates RWException, containing the reason for the failure in the exception.

authenticate

public java.lang.Object authenticate(java.lang.String username,
                                     java.lang.String password,
                                     java.util.Properties props)
                              throws oracle.reports.RWException

Authenticates a user against a target security system.

Parameters:

username - User name.

password - Password for the user.

props - Authentication properties, e.g., tnsname.

Returns:

If the authentication succeeds, an opaque user object (that only the security system understands) is returned. Otherwise it generates RWException, containing the reason for the failure in the exception.

jobCommandCheck

public void jobCommandCheck(java.lang.Object user,
                            Job job)
                     throws oracle.reports.RWException

Performs a security check for the job at runtime or at a scheduled time, depending on which queue the job is in. The user object is included in the job object.

Parameters:

user - User who wants to run the Web command.

job - Job to be checked.

If the security check fails, it generates RWException, containing the reason for the failure in the exception.

webCommandCheck

public void webCommandCheck(java.lang.Object user,
                            java.lang.String webCommand)
                     throws oracle.reports.RWException

Performs a security check for the Web command, such as showmap, showenv, etc.

Parameters:

user - User who wants to run the Web command.

webCommand - Web command.

If the security check fails, it generates RWException, containing the reason for the failure in the exception.

getRole

public int getRole(java.lang.Object user)
            throws oracle.reports.RWException

Returns the role for a given user.

Parameters:

user - User object.

Returns:

The roles defined in the idl, which can have the following values:

   ROLE_ADMINISTRATOR = 1;
   ROLE_DEVELOPER     = 2;
   ROLE_POWER_USER    = 3;
   ROLE_BASIC_USER    = 4;
 

getName

public java.lang.String getName()

Returns the name of the security system.