psdi.app.system

Class TenantStatusHandler

java.lang.Object

psdi.mbo.StatusHandler

psdi.app.system.TenantStatusHandler

All Implemented Interfaces:

MboConstants

public class TenantStatusHandler
extends StatusHandler

Handles all the status changes for a tenant registration object.

Field Summary

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
TenantStatusHandler(StatefulMbo sm) Constructor

Method Summary

Modifier and Type	Method and Description
void	canChangeStatus(java.lang.String currentStatus, java.lang.String desiredStatus, long accessModifier) Defines which status changes are legal.
void	changeStatus(java.lang.String currentStatus, java.lang.String desiredStatus, java.util.Date date, java.lang.String memo) Changes the status from the current state to a desired state.
void	checkStatusChangeAuthorization(java.lang.String desiredStatus) Checks to see if the user is authorized to make a status changes.
void	checkUserSecurity(java.lang.String desiredMaxStatus) Confirm the users security rights to call the specified status.

Methods inherited from class psdi.mbo.StatusHandler

postStatusChange, preStatusChange, updateMboForStatus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TenantStatusHandler

public TenantStatusHandler(StatefulMbo sm)

Constructor

Method Detail

checkStatusChangeAuthorization

public void checkStatusChangeAuthorization(java.lang.String desiredStatus)
                                    throws MXException,
                                           java.rmi.RemoteException

Checks to see if the user is authorized to make a status changes. In other words , it checks if the user has the required privilege to change the status. After ensuring that the user has the required privilege, checks if the status change is legal.

Specified by:

checkStatusChangeAuthorization in class StatusHandler

Parameters:

desiredExternalStatus - The desired external status of the asset.

Throws:

MXApplicationException - is thrown if the desired status

MXException

java.rmi.RemoteException

See Also:

This method is used to build the list of permitted status changes.

changeStatus

public void changeStatus(java.lang.String currentStatus,
                         java.lang.String desiredStatus,
                         java.util.Date date,
                         java.lang.String memo)
                  throws MXException,
                         java.rmi.RemoteException

Changes the status from the current state to a desired state. Also reloads the tenant's entry in the tenant cache since this status change may have impacted login ability.

Overrides:

changeStatus in class StatusHandler

Parameters:

currentStatus - the tenant's current status

desiredStatus - the status to change to

date - the date as of the status change is to be made

memo - memo text

Throws:

MXException

java.rmi.RemoteException

canChangeStatus

public void canChangeStatus(java.lang.String currentStatus,
                            java.lang.String desiredStatus,
                            long accessModifier)
                     throws MXException,
                            java.rmi.RemoteException

Defines which status changes are legal. If a status change is not legal, an exception is thrown. This method does not check the user's security clearance.

Overrides:

canChangeStatus in class StatusHandler

Parameters:

currentStatus - The tenant's current status

desiredStatus - The status to change to. This is the synonym value.

accessModifier - Ignored

Throws:

MXException - Throws an MXApplicationException if the desired status is New.

java.rmi.RemoteException

checkUserSecurity

public void checkUserSecurity(java.lang.String desiredMaxStatus)
                       throws MXException,
                              java.rmi.RemoteException

Confirm the users security rights to call the specified status. Note the status passed in is the INTERNAL status code.
Note that the SigOption Option Name doesn't always match the status name.

Parameters:

desiredMaxStatus - The status to check if we can change to.

Throws:

MXAccessException - Throws an access exception "notauthorized" if the check fails.

MXException

java.rmi.RemoteException