org.bedework.calsvci

Class CalSvcIPars

java.lang.Object

org.bedework.calsvci.CalSvcIPars

All Implemented Interfaces:

Serializable

public class CalSvcIPars
extends Object
implements Serializable

These are global parameters used by the CalSvc interface.

Author:

Mike Douglass douglm rpi.edu

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	logIdIndexer The id for the indexer process
static String	logIdRestore The id for the restore process

Constructor Summary

Constructors

Constructor and Description
CalSvcIPars(String logId, String authUser, String user, String calSuite, boolean publicAdmin, boolean allowSuperUser, boolean service, boolean publicSubmission, boolean adminCanEditAllPublicCategories, boolean adminCanEditAllPublicLocations, boolean adminCanEditAllPublicContacts, boolean sessionless, boolean dontKill) Constructor for this object.

Method Summary

Modifier and Type	Method and Description
Object	clone()
boolean	getAdminCanEditAllPublicCategories()
boolean	getAdminCanEditAllPublicContacts()
boolean	getAdminCanEditAllPublicLocations()
boolean	getAllowSuperUser()
String	getAuthUser()
static CalSvcIPars	getCaldavPars(String logId, String authUser, String runAsUser, String clientId, boolean allowSuperUser, boolean service, boolean publicAdmin, boolean allowCreateEprops, boolean readonly) Return new parameters for caldav.
String	getCalSuite()
String	getClientId()
boolean	getDontKill()
boolean	getForRestore()
static CalSvcIPars	getIndexerPars(String account, boolean publicAdmin) Return new pars for an index rebuild
boolean	getIndexRebuild()
String	getLogId()
boolean	getPublicAdmin()
boolean	getPublicSubmission()
boolean	getReadonly()
static CalSvcIPars	getRestorePars(String account) Return new pars for a system restore
boolean	getService()
static CalSvcIPars	getServicePars(String logId, String account, boolean publicAdmin, boolean allowSuperUser) Return new parameters for a service
boolean	getSessionsless()
String	getUser()
boolean	getWebMode()
boolean	isGuest()
void	setAuthUser(String val)
void	setCalSuite(String val)
void	setClientId(String val)
void	setLogId(String val)
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logIdIndexer

public static final String logIdIndexer

The id for the indexer process

See Also:

Constant Field Values

logIdRestore

public static final String logIdRestore

The id for the restore process

See Also:

Constant Field Values

Constructor Detail

CalSvcIPars

public CalSvcIPars(String logId,
                   String authUser,
                   String user,
                   String calSuite,
                   boolean publicAdmin,
                   boolean allowSuperUser,
                   boolean service,
                   boolean publicSubmission,
                   boolean adminCanEditAllPublicCategories,
                   boolean adminCanEditAllPublicLocations,
                   boolean adminCanEditAllPublicContacts,
                   boolean sessionless,
                   boolean dontKill)

Constructor for this object.

Parameters:

authUser - String authenticated user of the application

user - String user to act as

calSuite - String calSuite name

publicAdmin - true for admin

allowSuperUser - true to allow superuser mode in non-admin mode

service - true for a service

publicSubmission - true for the submit app

adminCanEditAllPublicCategories - true/false

adminCanEditAllPublicLocations - true/false

adminCanEditAllPublicContacts - true/false

sessionless - true if this is a sessionless client

dontKill - true if this is a system process

Method Detail

getServicePars

public static CalSvcIPars getServicePars(String logId,
                                         String account,
                                         boolean publicAdmin,
                                         boolean allowSuperUser)

Return new parameters for a service

Parameters:

logId - String used for labelling

account - - the account

publicAdmin - - true for public admin

allowSuperUser - - trie/false

Returns:

CalSvcIPars

getIndexerPars

public static CalSvcIPars getIndexerPars(String account,
                                         boolean publicAdmin)

Return new pars for an index rebuild

Parameters:

account - - the account

publicAdmin - - true for public admin

Returns:

CalSvcIPars

getRestorePars

public static CalSvcIPars getRestorePars(String account)

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,
                                        boolean allowCreateEprops,
                                        boolean readonly)

Return new parameters for caldav.

Parameters:

logId - String used for labelling

authUser - String authenticated user of the application

runAsUser - String user to run as

clientId - The application we're acting for.

allowSuperUser - true to allow superuser mode in non-admin mode

service - - true if this is a service call - e.g. iSchedule - rather than a real user.

publicAdmin - - true for public admin

allowCreateEprops - - allow create of new event properties, locations etc

Returns:

CalSvcIPars

setAuthUser

public void setAuthUser(String val)

Parameters:

val - String auth user

getAuthUser

public String getAuthUser()

Returns:

String auth user

getUser

public String getUser()

Returns:

String current user

setCalSuite

public void setCalSuite(String val)

Parameters:

val - String calSuite

getCalSuite

public String getCalSuite()

Returns:

String

setClientId

public void setClientId(String val)

Parameters:

val - String clientId

getClientId

public String getClientId()

Returns:

String

setLogId

public void setLogId(String val)

Parameters:

val - String logId

getLogId

public String getLogId()

Returns:

String

getPublicAdmin

public boolean getPublicAdmin()

Returns:

boolean true if this is a public admin object.

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..

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

public String toString()

Overrides:

toString in class Object

clone

public Object clone()

Overrides:

clone in class Object