org.bedework.calfacade.configs.SystemProperties Maven / Gradle / Ivy
Show all versions of bw-calendar-facade Show documentation
/* ********************************************************************
Licensed to Jasig under one or more contributor license
agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership.
Jasig licenses this file to you under the Apache License,
Version 2.0 (the "License"); you may not use this file
except in compliance with the License. You may obtain a
copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
package org.bedework.calfacade.configs;
import org.bedework.caldav.server.sysinterface.CalDAVSystemProperties;
import org.bedework.util.config.ConfInfo;
import org.bedework.util.jmx.MBeanInfo;
import java.util.List;
/** These are the system properties that the server needs to know about, either
* because it needs to apply these limits or just to report them to clients.
*
* Annotated to allow use by mbeans
*
* @author douglm
*
*/
@ConfInfo(elementName = "system-properties")
public interface SystemProperties extends CalDAVSystemProperties {
/** Set the default tzid
*
* @param val String
*/
void setTzid(String val);
/** Get the default tzid.
*
* @return String tzid
*/
@MBeanInfo("Default timezone identifier")
String getTzid();
/** Set the default systemid
*
* @param val String
*/
void setSystemid(String val);
/** Get the default systemid.
*
* @return String systemid
*/
@MBeanInfo("Systm identifier - used for uids etc.")
String getSystemid();
/** Set the root users list. This is a comma separated list of accounts that
* have superuser status.
*
* @param val String list of accounts
*/
void setRootUsers(String val);
/** Get the root users
*
* @return String root users
*/
@MBeanInfo("root users list. This is a comma separated list of accounts that" +
" have superuser status")
String getRootUsers();
/** Set the calws soap web service WSDL uri - null for no service
*
* @param val String
*/
void setCalSoapWsWSDLURI(String val);
/** Get the calws soap web service WSDL uri - null for no service
*
* @return String
*/
@MBeanInfo("Calws soap web service WSDL uri - null for no service")
String getCalSoapWsWSDLURI();
/** Set the userauth class
*
* @param val String userauth class
*/
void setUserauthClass(String val);
/**
*
* @return String
*/
@MBeanInfo("userauth class")
String getUserauthClass();
/** Set the mailer class
*
* @param val String mailer class
*/
void setMailerClass(String val);
/**
*
* @return String
*/
@MBeanInfo("mailer class")
String getMailerClass();
/** Set the admingroups class
*
* @param val String admingroups class
*/
void setAdmingroupsClass(String val);
/**
*
* @return String
*/
@MBeanInfo("admingroups class")
String getAdmingroupsClass();
/** Set the usergroups class
*
* @param val String usergroups class
*/
void setUsergroupsClass(String val);
/**
*
* @return String
*/
@MBeanInfo("usergroups class")
String getUsergroupsClass();
/** Set the supported locales list. This is maintained by getSupportedLocales and
* setSupportedLocales and is a comma separated list of locales in the usual
* form of the language, country and optional variant separated by "_"
*
*
The format is rigid, 2 letter language, 2 letter country. No spaces.
*
* @param val String supported locales
*/
void setLocaleList(String val);
/** Get the supported locales
*
* @return String supported locales
*/
@MBeanInfo("Comma separated list of locales. " +
"The format is rigid, 2 letter language, 2 letter country. No spaces.")
String getLocaleList();
/** Set the token for socket service
*
* @param val the token for socket service
*/
void setSocketToken(String val);
/** Get the token for socket service
*
* @return token
*/
@MBeanInfo("The token for socket service")
String getSocketToken();
/** Set the max minutes allowed since last webdav synch
*
* @param val minutes
*/
void setSynchMaxMinutes(int val);
/** Get the minutes for the hung transaction killer
*
* @return minutes
*/
@MBeanInfo("The max minutes allowed since last webdav synch")
int getSynchMaxMinutes();
/** Set the token for event reg admins
*
* @param val the token for event reg admins
*/
void setEventregAdminToken(String val);
/** Get the token for event reg admins
*
* @return token
*/
@MBeanInfo("The token for event reg admins")
String getEventregAdminToken();
/** Set the url for event reg service
*
* @param val the url for event reg service
*/
void setEventregUrl(String val);
/** Get the url for event reg service
*
* @return token
*/
@MBeanInfo("The url for event reg service")
String getEventregUrl();
/** Set the url for event reg web service
*
* @param val the url for event reg web service
*/
void setEventregWSUrl(String val);
/** Get the url for event reg web service
*
* @return token
*/
@MBeanInfo("The url for event reg web service")
String getEventregWSUrl();
/** Set the url prefix for the cache
*
* @param val the url prefix for the cache
*/
void setCacheUrlPrefix(String val);
/** Get the url prefix for the cache
*
* @return token
*/
@MBeanInfo("The url prefix for the cache")
String getCacheUrlPrefix();
/** Set the minutes for the hung transaction killer
*
* @param val minutes
*/
void setAutoKillMinutes(int val);
/** Get the minutes for the hung transaction killer
*
* @return minutes
*/
@MBeanInfo("The minutes for the hung transaction killer")
int getAutoKillMinutes();
/**
*
* @param val True if public events suggestion enabled
*/
void setSuggestionEnabled(boolean val);
/**
*
* @return True if public events suggestion enabled
*/
@MBeanInfo("True if public events suggestion enabled")
boolean getSuggestionEnabled();
/**
*
* @param val True if public events workflow enabled
*/
void setWorkflowEnabled(boolean val);
/**
*
* @return True if public events workflow enabled
*/
@MBeanInfo("True if public events workflow enabled")
boolean getWorkflowEnabled();
/** The root of the collections used for submission of public events by non-approvers.
*
* @param val - the path
*/
void setWorkflowRoot(String val);
/**
* @return String
*/
String getWorkflowRoot();
/** The root of the calendars used for submission of public events by users.
*
* @param val
*/
void setSubmissionRoot(String val);
/**
* @return String
*/
String getSubmissionRoot();
/**
*
* @param val True if default logged in user access limited to subscriptions
*/
void setUserSubscriptionsOnly(boolean val);
/**
*
* @return True if default logged in user access limited to subscriptions
*/
@MBeanInfo("True if default logged in user access limited to subscriptions")
boolean getUserSubscriptionsOnly();
/**
* @return copy of this
*/
SystemProperties cloneIt();
/* sysevents properties
*/
/**
*
* @param val the list of properties
*/
void setSyseventsProperties(final List val);
/**
*
* @return String val
*/
@ConfInfo(collectionElementName = "syseventsProperty" ,
elementType = "java.lang.String")
List getSyseventsProperties();
/** Add a sysevents property
*
* @param name of property
* @param val of property
*/
void addSyseventsProperty(final String name,
final String val);
/** Get a sysevents property
*
* @param name of property
* @return value or null
*/
@ConfInfo(dontSave = true)
String getSyseventsProperty(final String name);
/** Remove a sysevents property
*
* @param name of property
*/
void removeSyseventsProperty(final String name);
/** Set a sysevents property
*
* @param name of property
* @param val of property
*/
@ConfInfo(dontSave = true)
void setSyseventsProperty(String name,
String val);
/** True to run in test mode. This will adversely affect performance
* but avoids some test failures due to asynchronous behavior.
*
* DO NOT run in production mode with this on
.
*
* @param val true for test mode
*/
void setTestMode(boolean val);
/**
* @return CalAddrPrefixes or null
*/
@MBeanInfo("True to run in test mode. This will adversely affect performance\n" +
" * but avoids some test failures due to asynchronous behavior.\n" +
" *\n" +
" * DO NOT run in production mode with this on")
boolean getTestMode();
}