edu.internet2.middleware.grouper.ws
Class GrouperWsConfig

java.lang.Object
  extended by ConfigPropertiesCascadeBase
      extended by edu.internet2.middleware.grouper.ws.GrouperWsConfig

public final class GrouperWsConfig
extends ConfigPropertiesCascadeBase

config constants for WS

Author:
mchyzer

Field Summary
static java.lang.String WS_ACT_AS_CACHE_MINUTES
          name of param: ws.act.as.cache.seconds cache the decision to allow a user to actAs another, so it doesnt have to be calculated each time defaults to 30 minutes:
static java.lang.String WS_ACT_AS_GROUP
          name of param # Web service users who are in the following group can use the actAs field to act as someone else # You can put multiple groups separated by commas.
static java.lang.String WS_ADD_MEMBER_SUBJECTS_MAX
          name of param for add member web service max, default is 1000000 # Max number of subjects to be able to pass to addMember service, default is 1000000 ws.add.member.subjects.max = 20000
static java.lang.String WS_ASSIGN_ATTRIBUTE_DEF_NAME_INHERITANCE_MAX
          name of param for assignAttributeDefNameInheritance save, max assignAttributeDefNameInheritance to be able to save at once, default is 1000000 # Max number of assignAttributeDefNameInheritance to be able to pass to assignAttributeDefNameInheritance service, default is 1000000 ws.assign.attributeDefName.inheritance.max = 20000
static java.lang.String WS_ATTRIBUTE_DEF_DELETE_MAX
          name of param for attributedef delete, max attributedefs to be able to delete at once, default is 1000000 # Max number of attributedefs to be able to pass to attributedefDelete service, default is 1000000 ws.attributedef.delete.max = 20000
static java.lang.String WS_ATTRIBUTE_DEF_NAME_DELETE_MAX
          name of param for attributedefname delete, max attributedefnames to be able to delete at once, default is 1000000 # Max number of attributedefnames to be able to pass to attributedefnameDelete service, default is 1000000 ws.attributedefname.delete.max = 20000
static java.lang.String WS_ATTRIBUTE_DEF_NAME_SAVE_MAX
          name of param for attributeDefName save, max attributeDefNames to be able to save at once, default is 1000000 # Max number of attributeDefNames to be able to pass to attributeDefNameSave service, default is 1000000 ws.attributeDefName.save.max = 20000
static java.lang.String WS_ATTRIBUTE_DEF_SAVE_MAX
          name of param for attributeDef save, max attributeDef to be able to save at once, default is 1000000 # Max number of attributeDefs to be able to pass to attributeDefSave service, default is 1000000 ws.attributeDef.save.max = 20000
static java.lang.String WS_CLIENT_USER_GROUP_CACHE_MINUTES
          name of param: ws.client.user.group.cache.minutes cache the decision to allow a user to user web services, so it doesnt have to be calculated each time defaults to 30 minutes:
static java.lang.String WS_CLIENT_USER_GROUP_NAME
          name of param: ws.client.user.group.name If there is an entry here for group name, then all web service client users must be in this group (before the actAs) e.g.
static java.lang.String WS_DELETE_MEMBER_SUBJECTS_MAX
          name of param for delete member web service max, default is 1000000 # Max number of subjects to be able to pass to deleteMember service, default is 1000000 ws.delete.member.subjects.max = 20000
static java.lang.String WS_GET_GROUPS_SUBJECTS_MAX
          name of param for get groups web service max, default is 1000000 # Max number of subjects to be able to pass to getGroups service, default is 1000000 ws.get.groups.subjects.max = 20000
static java.lang.String WS_GROUP_ATTRIBUTE_MAX
          name of param for group attribute, max groups to be able to view/edit attributes at once, default is 1000000 # Max number of subjects to be able to pass to addMember service, default is 1000000 ws.group.save.max = 20000
static java.lang.String WS_GROUP_DELETE_MAX
          name of param for group delete, max groups to be able to delete at once, default is 1000000 # Max number of groups to be able to pass to groupDelete service, default is 1000000 ws.group.delete.max = 20000
static java.lang.String WS_GROUP_SAVE_MAX
          name of param for group save, max groups to be able to save at once, default is 1000000 # Max number of groups to be able to pass to groupSave service, default is 1000000 ws.group.save.max = 20000
static java.lang.String WS_HAS_MEMBER_SUBJECTS_MAX
          name of param for has member web service max, default is 1000000 # Max number of subjects to be able to pass to addMember service, default is 1000000 ws.has.member.subjects.max = 20000
static java.lang.String WS_LOGGED_IN_SUBJECT_DEFAULT_SOURCE
          name of param: ws.logged.in.subject.default.source if you have subject namespace overlap (or not), set the default subject source to lookup the user if none specified in user name
static java.lang.String WS_MEMBER_CHANGE_SUBJECT_MAX
          name of param for member change subject web service max, default is 1000000 # Max number of members to pass to memberChangeSubject, default is 1000000 ws.member.change.subject.max = 20000
static java.lang.String WS_REST_DEFAULT_RESPONSE_CONTENT_TYPE
          name of param: ws.rest.default.response.content.type if the request has no content type (http params), and the response content type is not specified in the url, then put it here.
static java.lang.String WS_SECURITY_NON_RAMPART_AUTHENTICATION_CLASS
          to provide custom authentication (instead of the default httpServletRequest.getUserPrincipal() for non-Rampart authentication.
static java.lang.String WS_SECURITY_RAMPART_AUTHENTICATION_CLASS
          to provide rampart authentication, Class must implement the interface: edu.internet2.middleware.grouper.ws.security.GrouperWssecAuthentication class must be fully qualified.
static java.lang.String WS_SEPARATOR
          when packing things in a single param, this is the separator
static java.lang.String WS_STEM_DELETE_MAX
          name of param for stem delete, max stems to be able to delete at once, default is 1000000 # Max number of stems to be able to pass to stemDelete service, default is 1000000 ws.stem.delete.max = 20000
static java.lang.String WS_STEM_SAVE_MAX
          name of param for stem save, max stems to be able to save at once, default is 1000000 # Max number of stems to be able to pass to stemSave service, default is 1000000 ws.stem.save.max = 20000
static java.lang.String WS_SUBJECT_RESULT_ATTRIBUTE_NAMES
          subject attribute names to send back when a WsSubject is sent, comma separated e.g.
static java.lang.String WS_SUBJECT_RESULT_DETAIL_ATTRIBUTE_NAMES
          name of param for subject result attribute names when extended data is requested # subject result attribute names when extended data is requested (comma separated) default is name, description note, these will be in addition to ws.subject.result.attribute.names
static java.lang.String WS_VIEW_OR_EDIT_PRIVILEGES_SUBJECTS_MAX
          name of param for save privileges web service max, default is 1000000 # Max number of subjects to be able to pass to savePrivileges service, default is 1000000 ws.view.or.edit.privileges.subjects.max = 20000
 
Method Summary
 void clearCachedCalculatedValues()
           
static java.util.Properties getProperties()
          Deprecated. use GrouperWsConfig.retrieveConfig().properties()
static boolean getPropertyBoolean(java.lang.String property, boolean defaultValue)
          Deprecated. use GrouperWsConfig.retrieveConfig().propertyValueBoolean instead
static int getPropertyInt(java.lang.String property, int defaultValue)
          Deprecated. use GrouperWsConfig.retrieveConfig().propertyValueInt instead
static java.lang.String getPropertyString(java.lang.String property)
          Deprecated. use GrouperWsConfig.retrieveConfig().propertyValueString instead
static java.lang.String getPropertyString(java.lang.String property, java.lang.String defaultValue)
          Deprecated. use GrouperWsConfig.retrieveConfig().propertyValueString instead
static GrouperWsConfig retrieveConfig()
          retrieve a config from the config file or from cache
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WS_ADD_MEMBER_SUBJECTS_MAX

public static final java.lang.String WS_ADD_MEMBER_SUBJECTS_MAX
name of param for add member web service max, default is 1000000 # Max number of subjects to be able to pass to addMember service, default is 1000000 ws.add.member.subjects.max = 20000

See Also:
Constant Field Values

WS_MEMBER_CHANGE_SUBJECT_MAX

public static final java.lang.String WS_MEMBER_CHANGE_SUBJECT_MAX
name of param for member change subject web service max, default is 1000000 # Max number of members to pass to memberChangeSubject, default is 1000000 ws.member.change.subject.max = 20000

See Also:
Constant Field Values

WS_GET_GROUPS_SUBJECTS_MAX

public static final java.lang.String WS_GET_GROUPS_SUBJECTS_MAX
name of param for get groups web service max, default is 1000000 # Max number of subjects to be able to pass to getGroups service, default is 1000000 ws.get.groups.subjects.max = 20000

See Also:
Constant Field Values

WS_GROUP_DELETE_MAX

public static final java.lang.String WS_GROUP_DELETE_MAX
name of param for group delete, max groups to be able to delete at once, default is 1000000 # Max number of groups to be able to pass to groupDelete service, default is 1000000 ws.group.delete.max = 20000

See Also:
Constant Field Values

WS_ATTRIBUTE_DEF_NAME_DELETE_MAX

public static final java.lang.String WS_ATTRIBUTE_DEF_NAME_DELETE_MAX
name of param for attributedefname delete, max attributedefnames to be able to delete at once, default is 1000000 # Max number of attributedefnames to be able to pass to attributedefnameDelete service, default is 1000000 ws.attributedefname.delete.max = 20000

See Also:
Constant Field Values

WS_ATTRIBUTE_DEF_DELETE_MAX

public static final java.lang.String WS_ATTRIBUTE_DEF_DELETE_MAX
name of param for attributedef delete, max attributedefs to be able to delete at once, default is 1000000 # Max number of attributedefs to be able to pass to attributedefDelete service, default is 1000000 ws.attributedef.delete.max = 20000

See Also:
Constant Field Values

WS_GROUP_SAVE_MAX

public static final java.lang.String WS_GROUP_SAVE_MAX
name of param for group save, max groups to be able to save at once, default is 1000000 # Max number of groups to be able to pass to groupSave service, default is 1000000 ws.group.save.max = 20000

See Also:
Constant Field Values

WS_ATTRIBUTE_DEF_NAME_SAVE_MAX

public static final java.lang.String WS_ATTRIBUTE_DEF_NAME_SAVE_MAX
name of param for attributeDefName save, max attributeDefNames to be able to save at once, default is 1000000 # Max number of attributeDefNames to be able to pass to attributeDefNameSave service, default is 1000000 ws.attributeDefName.save.max = 20000

See Also:
Constant Field Values

WS_ATTRIBUTE_DEF_SAVE_MAX

public static final java.lang.String WS_ATTRIBUTE_DEF_SAVE_MAX
name of param for attributeDef save, max attributeDef to be able to save at once, default is 1000000 # Max number of attributeDefs to be able to pass to attributeDefSave service, default is 1000000 ws.attributeDef.save.max = 20000

See Also:
Constant Field Values

WS_STEM_DELETE_MAX

public static final java.lang.String WS_STEM_DELETE_MAX
name of param for stem delete, max stems to be able to delete at once, default is 1000000 # Max number of stems to be able to pass to stemDelete service, default is 1000000 ws.stem.delete.max = 20000

See Also:
Constant Field Values

WS_ASSIGN_ATTRIBUTE_DEF_NAME_INHERITANCE_MAX

public static final java.lang.String WS_ASSIGN_ATTRIBUTE_DEF_NAME_INHERITANCE_MAX
name of param for assignAttributeDefNameInheritance save, max assignAttributeDefNameInheritance to be able to save at once, default is 1000000 # Max number of assignAttributeDefNameInheritance to be able to pass to assignAttributeDefNameInheritance service, default is 1000000 ws.assign.attributeDefName.inheritance.max = 20000

See Also:
Constant Field Values

WS_STEM_SAVE_MAX

public static final java.lang.String WS_STEM_SAVE_MAX
name of param for stem save, max stems to be able to save at once, default is 1000000 # Max number of stems to be able to pass to stemSave service, default is 1000000 ws.stem.save.max = 20000

See Also:
Constant Field Values

WS_GROUP_ATTRIBUTE_MAX

public static final java.lang.String WS_GROUP_ATTRIBUTE_MAX
name of param for group attribute, max groups to be able to view/edit attributes at once, default is 1000000 # Max number of subjects to be able to pass to addMember service, default is 1000000 ws.group.save.max = 20000

See Also:
Constant Field Values

WS_DELETE_MEMBER_SUBJECTS_MAX

public static final java.lang.String WS_DELETE_MEMBER_SUBJECTS_MAX
name of param for delete member web service max, default is 1000000 # Max number of subjects to be able to pass to deleteMember service, default is 1000000 ws.delete.member.subjects.max = 20000

See Also:
Constant Field Values

WS_HAS_MEMBER_SUBJECTS_MAX

public static final java.lang.String WS_HAS_MEMBER_SUBJECTS_MAX
name of param for has member web service max, default is 1000000 # Max number of subjects to be able to pass to addMember service, default is 1000000 ws.has.member.subjects.max = 20000

See Also:
Constant Field Values

WS_SUBJECT_RESULT_DETAIL_ATTRIBUTE_NAMES

public static final java.lang.String WS_SUBJECT_RESULT_DETAIL_ATTRIBUTE_NAMES
name of param for subject result attribute names when extended data is requested # subject result attribute names when extended data is requested (comma separated) default is name, description note, these will be in addition to ws.subject.result.attribute.names

See Also:
Constant Field Values

WS_SUBJECT_RESULT_ATTRIBUTE_NAMES

public static final java.lang.String WS_SUBJECT_RESULT_ATTRIBUTE_NAMES
subject attribute names to send back when a WsSubject is sent, comma separated e.g. name, netid default is none

See Also:
Constant Field Values

WS_SEPARATOR

public static final java.lang.String WS_SEPARATOR
when packing things in a single param, this is the separator

See Also:
Constant Field Values

WS_ACT_AS_GROUP

public static final java.lang.String WS_ACT_AS_GROUP
name of param # Web service users who are in the following group can use the actAs field to act as someone else # You can put multiple groups separated by commas. e.g. a:b:c, e:f:g # You can put a single entry as the group the calling user has to be in, and the grouper the actAs has to be in # separated by 4 colons # e.g. if the configured values is: a:b:c, e:f:d :::: r:e:w, x:e:w # then if the calling user is in a:b:c or x:e:w, then the actAs can be anyone # if not, then if the calling user is in e:f:d, then the actAs must be in r:e:w. If multiple rules, then # if one passes, then it is a success, if they all fail, then fail. field to act as someone else ws.act.as.group = aStem:aGroup

See Also:
Constant Field Values

WS_ACT_AS_CACHE_MINUTES

public static final java.lang.String WS_ACT_AS_CACHE_MINUTES
name of param: ws.act.as.cache.seconds cache the decision to allow a user to actAs another, so it doesnt have to be calculated each time defaults to 30 minutes:

See Also:
Constant Field Values

WS_LOGGED_IN_SUBJECT_DEFAULT_SOURCE

public static final java.lang.String WS_LOGGED_IN_SUBJECT_DEFAULT_SOURCE
name of param: ws.logged.in.subject.default.source if you have subject namespace overlap (or not), set the default subject source to lookup the user if none specified in user name

See Also:
Constant Field Values

WS_VIEW_OR_EDIT_PRIVILEGES_SUBJECTS_MAX

public static final java.lang.String WS_VIEW_OR_EDIT_PRIVILEGES_SUBJECTS_MAX
name of param for save privileges web service max, default is 1000000 # Max number of subjects to be able to pass to savePrivileges service, default is 1000000 ws.view.or.edit.privileges.subjects.max = 20000

See Also:
Constant Field Values

WS_REST_DEFAULT_RESPONSE_CONTENT_TYPE

public static final java.lang.String WS_REST_DEFAULT_RESPONSE_CONTENT_TYPE
name of param: ws.rest.default.response.content.type if the request has no content type (http params), and the response content type is not specified in the url, then put it here. must be a valid value of WsLiteResponseContentType defaults to xhtml if blank

See Also:
Constant Field Values

WS_SECURITY_NON_RAMPART_AUTHENTICATION_CLASS

public static final java.lang.String WS_SECURITY_NON_RAMPART_AUTHENTICATION_CLASS
to provide custom authentication (instead of the default httpServletRequest.getUserPrincipal() for non-Rampart authentication. Class must implement the interface: edu.internet2.middleware.grouper.ws.security.WsCustomAuthentication class must be fully qualified. e.g. edu.school.whatever.MyAuthenticator blank means use default: edu.internet2.middleware.grouper.ws.security.WsGrouperDefaultAuthentication ws.security.non-rampart.authentication.class =

See Also:
Constant Field Values

WS_SECURITY_RAMPART_AUTHENTICATION_CLASS

public static final java.lang.String WS_SECURITY_RAMPART_AUTHENTICATION_CLASS
to provide rampart authentication, Class must implement the interface: edu.internet2.middleware.grouper.ws.security.GrouperWssecAuthentication class must be fully qualified. e.g. edu.school.whatever.MyAuthenticator blank means rampart will throw 404 status code

See Also:
Constant Field Values

WS_CLIENT_USER_GROUP_NAME

public static final java.lang.String WS_CLIENT_USER_GROUP_NAME
name of param: ws.client.user.group.name If there is an entry here for group name, then all web service client users must be in this group (before the actAs) e.g. etc:webServiceClientUsers

See Also:
Constant Field Values

WS_CLIENT_USER_GROUP_CACHE_MINUTES

public static final java.lang.String WS_CLIENT_USER_GROUP_CACHE_MINUTES
name of param: ws.client.user.group.cache.minutes cache the decision to allow a user to user web services, so it doesnt have to be calculated each time defaults to 30 minutes:

See Also:
Constant Field Values
Method Detail

retrieveConfig

public static GrouperWsConfig retrieveConfig()
retrieve a config from the config file or from cache

Returns:
the config object

getPropertyString

@Deprecated
public static java.lang.String getPropertyString(java.lang.String property)
Deprecated. use GrouperWsConfig.retrieveConfig().propertyValueString instead

Get a Grouper configuration parameter.
 String wheel = GrouperConfig.getProperty("groups.wheel.group");
 

Parameters:
property - to lookup
Returns:
Value of configuration parameter or an empty string if parameter is invalid.
Since:
1.1.0

getProperties

@Deprecated
public static java.util.Properties getProperties()
Deprecated. use GrouperWsConfig.retrieveConfig().properties()

get all properties

Returns:
all properties

getPropertyString

@Deprecated
public static java.lang.String getPropertyString(java.lang.String property,
                                                            java.lang.String defaultValue)
Deprecated. use GrouperWsConfig.retrieveConfig().propertyValueString instead

Get a Grouper configuration parameter.
 String wheel = GrouperConfig.getProperty("groups.wheel.group");
 

Parameters:
property - to lookup
defaultValue - is the value if the property isnt found
Returns:
Value of configuration parameter or the default value (will trim the value)
Since:
1.1.0

getPropertyInt

@Deprecated
public static int getPropertyInt(java.lang.String property,
                                            int defaultValue)
Deprecated. use GrouperWsConfig.retrieveConfig().propertyValueInt instead

Get a Grouper configuration parameter an integer

Parameters:
property - to lookup
defaultValue - of the int if not there
Returns:
Value of configuration parameter or null if parameter isnt specified. Exception is thrown if not formatted correcly

getPropertyBoolean

@Deprecated
public static boolean getPropertyBoolean(java.lang.String property,
                                                    boolean defaultValue)
Deprecated. use GrouperWsConfig.retrieveConfig().propertyValueBoolean instead

Get a Grouper configuration parameter as boolean (must be true|t|false|f case-insensitive)

Parameters:
property - to lookup
defaultValue - if the property is not there
Returns:
Value of configuration parameter or null if parameter isnt specified. Exception is thrown if not formatted correcly

clearCachedCalculatedValues

public void clearCachedCalculatedValues()
See Also:
ConfigPropertiesCascadeBase#clearCachedCalculatedValues