psdi.app.site

Class SiteService

java.lang.Object

psdi.server.AppService

psdi.app.site.SiteService

All Implemented Interfaces:

java.rmi.Remote, SiteServiceRemote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class SiteService
extends AppService
implements SiteServiceRemote

The site package service object.

Author:

John Neville

Field Summary

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
SiteService() Call SiteCache init.
SiteService(MXServer mxServer) Call SiteCache init.

Method Summary

Modifier and Type	Method and Description
java.util.Hashtable	getAllSites() Get a listing of all sites.
java.lang.String	getCompanySetIdForOrg(UserInfo userInfo, java.lang.String orgId) Get the company set ID for the specified organization ID.
java.lang.String	getItemSetIdForOrg(UserInfo userInfo, java.lang.String orgId) Get the item set ID for the specified organization ID.
java.lang.String	getOrgForSite(java.lang.String siteID, UserInfo userInfo) Return the organization for the specified site.
boolean	orgHasASite(java.lang.String orgID) Determines whether the organization contains at least one Site.
void	validateOrgForSite(UserInfo userInfo, java.lang.String orgId, java.lang.String siteId) Validates that the specified site is within the specified organization.

Methods inherited from class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, init, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Constructor Detail

SiteService

public SiteService()
            throws java.rmi.RemoteException

Call SiteCache init.

Throws:

java.rmi.RemoteException

See Also:

SiteCache, MXServer.addToMaximoCache(java.lang.String, psdi.mbo.MaximoCache)

SiteService

public SiteService(MXServer mxServer)
            throws java.rmi.RemoteException

Call SiteCache init.

Throws:

java.rmi.RemoteException

See Also:

SiteCache, MXServer.addToMaximoCache(java.lang.String, psdi.mbo.MaximoCache)

Method Detail

getOrgForSite

public java.lang.String getOrgForSite(java.lang.String siteID,
                                      UserInfo userInfo)
                               throws MXException,
                                      java.rmi.RemoteException

Return the organization for the specified site.

Specified by:

getOrgForSite in interface SiteServiceRemote

Parameters:

siteID - The site for which the orgID is being requested.

userInfo - UserInfo making the request.

Returns:

The organization the site belongs to. This is locale-specific (i.e. if orgid is numeric, the return value may contain commas). If the site does not exist, this will return null.

Throws:

MXException

java.rmi.RemoteException

See Also:

SiteCache.getOrgForSite(java.lang.String, psdi.security.UserInfo)

orgHasASite

public boolean orgHasASite(java.lang.String orgID)
                    throws MXException,
                           java.rmi.RemoteException

Determines whether the organization contains at least one Site.

Specified by:

orgHasASite in interface SiteServiceRemote

Parameters:

orgID - The organization being checked.

Returns:

true if the Organization contains at least one site false otherwise

Throws:

MXException

java.rmi.RemoteException

See Also:

orgHasASite(java.lang.String)

getAllSites

public java.util.Hashtable getAllSites()
                                throws MXException,
                                       java.rmi.RemoteException

Get a listing of all sites.

Specified by:

getAllSites in interface SiteServiceRemote

Returns:

Hashtable where key = siteid, value = orgid. Will include all sites that exist on the database.

Throws:

MXException

java.rmi.RemoteException

See Also:

SiteCache.getAllSites()

validateOrgForSite

public void validateOrgForSite(UserInfo userInfo,
                               java.lang.String orgId,
                               java.lang.String siteId)
                        throws MXException,
                               java.rmi.RemoteException

Validates that the specified site is within the specified organization.

Specified by:

validateOrgForSite in interface SiteServiceRemote

Parameters:

userInfo - UserInfo object

orgid - organization that will be searched for the specified site

siteid - site to be checked

Throws:

MXApplicationException("locations", - "invalidorgsite", params)is thrown when the site is in not in the organization.

MXException

java.rmi.RemoteException

See Also:

validateOrgForSite(psdi.security.UserInfo, java.lang.String, java.lang.String)

getItemSetIdForOrg

public java.lang.String getItemSetIdForOrg(UserInfo userInfo,
                                           java.lang.String orgId)
                                    throws MXException,
                                           java.rmi.RemoteException

Get the item set ID for the specified organization ID.

Specified by:

getItemSetIdForOrg in interface SiteServiceRemote

Parameters:

userInfo - UserInfo object

orgid - organization identifier

Throws:

MXException

java.rmi.RemoteException

See Also:

getItemSetIdForOrg(psdi.security.UserInfo, java.lang.String)

getCompanySetIdForOrg

public java.lang.String getCompanySetIdForOrg(UserInfo userInfo,
                                              java.lang.String orgId)
                                       throws MXException,
                                              java.rmi.RemoteException

Get the company set ID for the specified organization ID.

Specified by:

getCompanySetIdForOrg in interface SiteServiceRemote

Parameters:

userInfo - UserInfo object

orgid - organization identifier

Throws:

MXException

java.rmi.RemoteException

See Also:

getCompanySetIdForOrg(psdi.security.UserInfo, java.lang.String)