Package org.bedework.calfacade.svc
Class CalSvcIPars
java.lang.Object
org.bedework.calfacade.svc.CalSvcIPars
- All Implemented Interfaces:
Serializable
These are global parameters used by the CalSvc interface.
- Author:
- Mike Douglass douglm rpi.edu
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe id prefix for the admin clientstatic final StringThe id for the dump processstatic final StringThe id for the indexer processstatic final StringThe id for the restore processstatic final StringThe id prefix for the ro clientstatic final StringThe id prefix for the rw clientstatic final StringThe id for the tools util process -
Constructor Summary
ConstructorsConstructorDescriptionCalSvcIPars(String logId, String authUser, String user, String calSuite, boolean publicAdmin, boolean publicAuth, boolean allowSuperUser, boolean service, boolean publicSubmission, boolean adminCanEditAllPublicCategories, boolean adminCanEditAllPublicLocations, boolean adminCanEditAllPublicContacts, boolean sessionless, boolean dontKill, boolean readonly, String clientId, boolean forRestore, boolean indexRebuild) Constructor for this object. -
Method Summary
Modifier and TypeMethodDescriptionclone()cloneRo()booleanbooleanbooleanstatic CalSvcIParsgetAdminClientPars(String id, String authUser, String user, String calSuite, boolean adminCanEditAllPublicCategories, boolean adminCanEditAllPublicLocations, boolean adminCanEditAllPublicContacts) booleanstatic CalSvcIParsgetCaldavPars(String logId, String authUser, String runAsUser, String clientId, boolean allowSuperUser, boolean service, boolean publicAdmin, String calSuite, boolean allowCreateEprops, boolean readonly) Return new parameters for caldav.booleanstatic CalSvcIParsgetDumpRestorePars(String id, String account, boolean superUser) Return new pars for a system restorebooleanstatic CalSvcIParsgetIndexerPars(String account, boolean publicAdmin) Return new pars for an index rebuildbooleangetLogId()booleanbooleanbooleanbooleanstatic CalSvcIParsgetRoClientPars(String id, String authUser, String user, String calSuite, boolean publicAuth) static CalSvcIParsgetRwClientPars(String id, String authUser, String user) booleanstatic CalSvcIParsgetServicePars(String logId, String account, boolean publicAdmin, boolean allowSuperUser) Return new parameters for a servicebooleanstatic CalSvcIParsgetToolPars(String user, boolean superUser) getUser()booleanbooleanisGuest()voidsetAuthUser(String val) voidsetCalSuite(String val) voidvoidsetReadonly(Boolean val) toString()
-
Field Details
-
logIdRoClient
The id prefix for the ro client- See Also:
-
logIdRwClient
The id prefix for the rw client- See Also:
-
logIdAdminClient
The id prefix for the admin client- See Also:
-
logIdTools
The id for the tools util process- See Also:
-
logIdIndexer
The id for the indexer process- See Also:
-
logIdDump
The id for the dump process- See Also:
-
logIdRestore
The id for the restore process- See Also:
-
-
Constructor Details
-
CalSvcIPars
public CalSvcIPars(String logId, String authUser, String user, String calSuite, boolean publicAdmin, boolean publicAuth, boolean allowSuperUser, boolean service, boolean publicSubmission, boolean adminCanEditAllPublicCategories, boolean adminCanEditAllPublicLocations, boolean adminCanEditAllPublicContacts, boolean sessionless, boolean dontKill, boolean readonly, String clientId, boolean forRestore, boolean indexRebuild) Constructor for this object.- Parameters:
authUser- String authenticated user of the applicationuser- String user to act ascalSuite- String calSuite namepublicAdmin- true for adminpublicAuth- true for authenticated public clientallowSuperUser- true to allow superuser mode in non-admin modeservice- true for a servicepublicSubmission- true for the submit appadminCanEditAllPublicCategories- true/falseadminCanEditAllPublicLocations- true/falseadminCanEditAllPublicContacts- true/falsesessionless- true if this is a sessionless clientdontKill- true if this is a system processreadonly- true if this is a readonly process
-
-
Method Details
-
getRoClientPars
public static CalSvcIPars getRoClientPars(String id, String authUser, String user, String calSuite, boolean publicAuth) -
getRwClientPars
-
getAdminClientPars
public static CalSvcIPars getAdminClientPars(String id, String authUser, String user, String calSuite, boolean adminCanEditAllPublicCategories, boolean adminCanEditAllPublicLocations, boolean adminCanEditAllPublicContacts) -
getToolPars
-
getServicePars
public static CalSvcIPars getServicePars(String logId, String account, boolean publicAdmin, boolean allowSuperUser) Return new parameters for a service- Parameters:
logId- String used for labellingaccount- - the accountpublicAdmin- - true for public adminallowSuperUser- - trie/false- Returns:
- CalSvcIPars
-
getIndexerPars
Return new pars for an index rebuild- Parameters:
account- - the accountpublicAdmin- - true for public admin- Returns:
- CalSvcIPars
-
getDumpRestorePars
Return new pars for a system restore- Parameters:
account- - the account- Returns:
- CalSvcIPars
-
getCaldavPars
public static CalSvcIPars getCaldavPars(String logId, String authUser, String runAsUser, String clientId, boolean allowSuperUser, boolean service, boolean publicAdmin, String calSuite, boolean allowCreateEprops, boolean readonly) Return new parameters for caldav.- Parameters:
logId- String used for labellingauthUser- String authenticated user of the applicationrunAsUser- String user to run asclientId- The application we're acting for.allowSuperUser- true to allow superuser mode in non-admin modeservice- - true if this is a service call - e.g. iSchedule - rather than a real user.publicAdmin- - true for public adminallowCreateEprops- - allow create of new event properties, locations etc- Returns:
- CalSvcIPars
-
setAuthUser
- Parameters:
val- String auth user
-
getAuthUser
- Returns:
- String auth user
-
getUser
- Returns:
- String current user
-
setCalSuite
- Parameters:
val- String calSuite
-
getCalSuite
- Returns:
- String
-
getClientId
- Returns:
- String
-
setLogId
- Parameters:
val- String logId
-
getLogId
- Returns:
- String
-
getPublicAdmin
public boolean getPublicAdmin()- Returns:
- boolean true if this is a public admin object.
-
getPublicAuth
public boolean getPublicAuth()- Returns:
- boolean true if this is a public authenticated client.
-
getPublicSubmission
public boolean getPublicSubmission() -
getService
public boolean getService()- Returns:
- boolean true if this is a service.
-
getAllowSuperUser
public boolean getAllowSuperUser()- Returns:
- boolean true if we allow superuser mode in non-admin.
-
getAdminCanEditAllPublicCategories
public boolean getAdminCanEditAllPublicCategories()- Returns:
- boolean
-
getAdminCanEditAllPublicLocations
public boolean getAdminCanEditAllPublicLocations()- Returns:
- boolean
-
getAdminCanEditAllPublicContacts
public boolean getAdminCanEditAllPublicContacts()- Returns:
- boolean
-
getSessionsless
public boolean getSessionsless()- Returns:
- boolean true if this is a sessionless client..
-
getDontKill
public boolean getDontKill()- Returns:
- boolean true if this is a system process.
-
getWebMode
public boolean getWebMode()- Returns:
- boolean true if this is a web client..
-
setReadonly
- Parameters:
val- readonly flag
-
getReadonly
public boolean getReadonly()- Returns:
- boolean true if this is a read-only request.
-
getForRestore
public boolean getForRestore()- Returns:
- boolean true if this is for restore of system..
-
getIndexRebuild
public boolean getIndexRebuild()- Returns:
- boolean true if this is for an index rebuild.
-
isGuest
public boolean isGuest()- Returns:
- boolean true for guest
-
toString
-
clone
-
cloneRo
-