edu.internet2.middleware.grouper.rules
Class RuleUtils

java.lang.Object
  edu.internet2.middleware.grouper.rules.RuleUtils

public class RuleUtils
extends java.lang.Object

Field Summary

static java.lang.String	RULE_ACT_AS_SUBJECT_ID
static java.lang.String	RULE_ACT_AS_SUBJECT_IDENTIFIER
static java.lang.String	RULE_ACT_AS_SUBJECT_SOURCE_ID
static java.lang.String	RULE_CHECK_ARG0
static java.lang.String	RULE_CHECK_ARG1
static java.lang.String	RULE_CHECK_OWNER_ID
static java.lang.String	RULE_CHECK_OWNER_NAME
static java.lang.String	RULE_CHECK_STEM_SCOPE
static java.lang.String	RULE_CHECK_TYPE
static java.lang.String	RULE_IF_CONDITION_EL
static java.lang.String	RULE_IF_CONDITION_ENUM
static java.lang.String	RULE_IF_CONDITION_ENUM_ARG0
static java.lang.String	RULE_IF_CONDITION_ENUM_ARG1
static java.lang.String	RULE_IF_OWNER_ID
static java.lang.String	RULE_IF_OWNER_NAME
static java.lang.String	RULE_IF_STEM_SCOPE
static java.lang.String	RULE_RUN_DAEMON should be T or F
static java.lang.String	RULE_THEN_EL
static java.lang.String	RULE_THEN_ENUM
static java.lang.String	RULE_THEN_ENUM_ARG0
static java.lang.String	RULE_THEN_ENUM_ARG1
static java.lang.String	RULE_THEN_ENUM_ARG2
static java.lang.String	RULE_VALID

Constructor Summary

RuleUtils()

Method Summary

static AttributeDef	attributeDef(java.lang.String attributeDefId, java.lang.String attributeDefName, java.lang.String alternateAttributeDefId, boolean useRootSession, boolean throwExceptionIfNotFound)
static java.lang.String	attributeRuleStemName() return the stem name where the rule attributes go, without colon on end
static java.lang.String	emailTemplate(java.lang.String emailTemplateString) if it starts with template: then get the arg from a file.
static boolean	folderHasMembership(RulesBean rulesBean, java.lang.String stemId, java.lang.String stemName, Stem.Scope stemScope, MembershipType membershipType) see if there is a membership in the folder
static Group	group(java.lang.String groupId, java.lang.String groupName, java.lang.String alternateGroupId, boolean useRootSession, boolean throwExceptionIfNotFound)
static boolean	groupHasImmediateEnabledMembership(RulesBean rulesBean, java.lang.String groupId)
static java.util.Set<PermissionEntry>	permissionsForUser(java.lang.String attributeDefId, RulesBean rulesBean, boolean noEndDate)
static java.util.Set<PermissionEntry>	permissionsForUser(java.lang.String attributeDefId, java.lang.String memberId, boolean noEndDate)
static java.lang.String	removeSurroundingQuotesConvertNull(java.lang.String string) take in a string, e.g.
static java.lang.String	ruleActAsSubjectIdentifierName() full rule then el name
static java.lang.String	ruleActAsSubjectIdName() full ruleActAsSubjectIdName
static java.lang.String	ruleActAsSubjectSourceIdName() full ruleActAsSubjectSourceIdName
static AttributeDef	ruleAttrAttributeDef() return the rule attr attribute def this throws exception if cant find
static AttributeDefName	ruleAttributeDefName() return the rule attribute def name, assign this to an object to attach a rule.
static java.lang.String	ruleCheckArg0Name() full ruleCheckArg0Name
static java.lang.String	ruleCheckArg1Name() full ruleCheckArg1Name
static java.lang.String	ruleCheckOwnerIdName() full ruleCheckOwnerIdName
static java.lang.String	ruleCheckOwnerNameName() full ruleCheckOwnerName
static java.lang.String	ruleCheckStemScopeName() full ruleCheckStemScope
static java.lang.String	ruleCheckTypeName() full ruleCheckTypeName
static java.lang.String	ruleIfConditionElName() full rule ruleIfConditionElName
static java.lang.String	ruleIfConditionEnumArg0Name() full rule if condition enum arg0 name
static java.lang.String	ruleIfConditionEnumArg1Name() full rule if condition enum arg1 name
static java.lang.String	ruleIfConditionEnumName() full rule if condition enum name
static java.lang.String	ruleIfOwnerIdName() full ruleIfOwnerIdName
static java.lang.String	ruleIfOwnerNameName() full ruleIfOwnerName
static java.lang.String	ruleIfStemScopeName() full ruleIfStemScopeName
static java.lang.String	ruleRunDaemonName() full rule run daemon name
static java.lang.String	ruleThenElName() full rule then el name
static java.lang.String	ruleThenEnumArg0Name() full rule then enum arg0 name
static java.lang.String	ruleThenEnumArg1Name() full rule then enum arg1 name
static java.lang.String	ruleThenEnumArg2Name() full rule then enum arg2 name
static java.lang.String	ruleThenEnumName() full rule then enum name
static AttributeDef	ruleTypeAttributeDef() return the rule type attribute def this throws exception if cant find
static AttributeDefName	ruleValidAttributeDefName() return the rule attribute def name, assign this to an object to attach a rule.
static java.lang.String	ruleValidName() full rule valid name name
static Stem	stem(java.lang.String stemId, java.lang.String stemName, java.lang.String alternateStemId, boolean useRootSession, boolean throwExceptionIfNotFound)
static java.lang.String	validateAttributeDef(java.lang.String attributeDefId, java.lang.String attributeDefName, java.lang.String alternateAttributeDefId)
static java.lang.String	validateGroup(java.lang.String groupId, java.lang.String groupName, java.lang.String alternateGroupId)
static java.lang.String	validateStem(java.lang.String stemId, java.lang.String stemName, java.lang.String alternateStemId)

Methods inherited from class java.lang.Object

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

Field Detail

RULE_THEN_EL

public static final java.lang.String RULE_THEN_EL

See Also:

Constant Field Values

RULE_RUN_DAEMON

public static final java.lang.String RULE_RUN_DAEMON

should be T or F

See Also:

Constant Field Values

RULE_VALID

public static final java.lang.String RULE_VALID

See Also:

Constant Field Values

RULE_THEN_ENUM

public static final java.lang.String RULE_THEN_ENUM

See Also:

Constant Field Values

RULE_THEN_ENUM_ARG0

public static final java.lang.String RULE_THEN_ENUM_ARG0

See Also:

Constant Field Values

RULE_THEN_ENUM_ARG1

public static final java.lang.String RULE_THEN_ENUM_ARG1

See Also:

Constant Field Values

RULE_THEN_ENUM_ARG2

public static final java.lang.String RULE_THEN_ENUM_ARG2

See Also:

Constant Field Values

RULE_IF_CONDITION_ENUM

public static final java.lang.String RULE_IF_CONDITION_ENUM

See Also:

Constant Field Values

RULE_IF_CONDITION_ENUM_ARG0

public static final java.lang.String RULE_IF_CONDITION_ENUM_ARG0

See Also:

Constant Field Values

RULE_IF_CONDITION_ENUM_ARG1

public static final java.lang.String RULE_IF_CONDITION_ENUM_ARG1

See Also:

Constant Field Values

RULE_IF_CONDITION_EL

public static final java.lang.String RULE_IF_CONDITION_EL

See Also:

Constant Field Values

RULE_IF_OWNER_NAME

public static final java.lang.String RULE_IF_OWNER_NAME

See Also:

Constant Field Values

RULE_CHECK_OWNER_NAME

public static final java.lang.String RULE_CHECK_OWNER_NAME

See Also:

Constant Field Values

RULE_CHECK_STEM_SCOPE

public static final java.lang.String RULE_CHECK_STEM_SCOPE

See Also:

Constant Field Values

RULE_CHECK_OWNER_ID

public static final java.lang.String RULE_CHECK_OWNER_ID

See Also:

Constant Field Values

RULE_CHECK_ARG0

public static final java.lang.String RULE_CHECK_ARG0

See Also:

Constant Field Values

RULE_CHECK_ARG1

public static final java.lang.String RULE_CHECK_ARG1

See Also:

Constant Field Values

RULE_IF_OWNER_ID

public static final java.lang.String RULE_IF_OWNER_ID

See Also:

Constant Field Values

RULE_IF_STEM_SCOPE

public static final java.lang.String RULE_IF_STEM_SCOPE

See Also:

Constant Field Values

RULE_CHECK_TYPE

public static final java.lang.String RULE_CHECK_TYPE

See Also:

Constant Field Values

RULE_ACT_AS_SUBJECT_SOURCE_ID

public static final java.lang.String RULE_ACT_AS_SUBJECT_SOURCE_ID

See Also:

Constant Field Values

RULE_ACT_AS_SUBJECT_IDENTIFIER

public static final java.lang.String RULE_ACT_AS_SUBJECT_IDENTIFIER

See Also:

Constant Field Values

RULE_ACT_AS_SUBJECT_ID

public static final java.lang.String RULE_ACT_AS_SUBJECT_ID

See Also:

Constant Field Values

Constructor Detail

RuleUtils

public RuleUtils()

Method Detail

groupHasImmediateEnabledMembership

public static boolean groupHasImmediateEnabledMembership(RulesBean rulesBean,
                                                         java.lang.String groupId)

Parameters:

rulesBean -

groupId -

Returns:

folderHasMembership

public static boolean folderHasMembership(RulesBean rulesBean,
                                          java.lang.String stemId,
                                          java.lang.String stemName,
                                          Stem.Scope stemScope,
                                          MembershipType membershipType)

see if there is a membership in the folder

Parameters:

rulesBean -

stemId - add either this or stem name

stemName - add either this or stem id

stemScope -

membershipType - null for any

Returns:

true if membership, false if not

permissionsForUser

public static java.util.Set<PermissionEntry> permissionsForUser(java.lang.String attributeDefId,
                                                                RulesBean rulesBean,
                                                                boolean noEndDate)

Parameters:

attributeDefId -

rulesBean -

noEndDate -

Returns:

the set of permissions entries

permissionsForUser

public static java.util.Set<PermissionEntry> permissionsForUser(java.lang.String attributeDefId,
                                                                java.lang.String memberId,
                                                                boolean noEndDate)

Parameters:

attributeDefId -

rulesBean -

memberId -

noEndDate -

Returns:

the set of permissions entries

emailTemplate

public static java.lang.String emailTemplate(java.lang.String emailTemplateString)

if it starts with template: then get the arg from a file. If it doesnt, then it is the template, return that. if there is a problem retrieving the template, then throw exception. if the template name is invalid, throw exception

Parameters:

emailTemplateString -

Returns:

the email template

removeSurroundingQuotesConvertNull

public static java.lang.String removeSurroundingQuotesConvertNull(java.lang.String string)

take in a string, e.g. "this", and return it without quotes on the outside

Parameters:

string -

Returns:

the string

ruleAttributeDefName

public static AttributeDefName ruleAttributeDefName()

return the rule attribute def name, assign this to an object to attach a rule. this throws exception if cant find

Returns:

the attribute def name

ruleValidAttributeDefName

public static AttributeDefName ruleValidAttributeDefName()

return the rule attribute def name, assign this to an object to attach a rule. this throws exception if cant find

Returns:

the attribute def name

ruleTypeAttributeDef

public static AttributeDef ruleTypeAttributeDef()

return the rule type attribute def this throws exception if cant find

Returns:

the attribute def

ruleAttrAttributeDef

public static AttributeDef ruleAttrAttributeDef()

return the rule attr attribute def this throws exception if cant find

Returns:

the attribute def

attributeRuleStemName

public static java.lang.String attributeRuleStemName()

return the stem name where the rule attributes go, without colon on end

Returns:

stem name

ruleThenElName

public static java.lang.String ruleThenElName()

full rule then el name

Returns:

name

ruleRunDaemonName

public static java.lang.String ruleRunDaemonName()

full rule run daemon name

Returns:

name

ruleValidName

public static java.lang.String ruleValidName()

full rule valid name name

Returns:

name

ruleThenEnumName

public static java.lang.String ruleThenEnumName()

full rule then enum name

Returns:

name

ruleThenEnumArg0Name

public static java.lang.String ruleThenEnumArg0Name()

full rule then enum arg0 name

Returns:

name

ruleThenEnumArg1Name

public static java.lang.String ruleThenEnumArg1Name()

full rule then enum arg1 name

Returns:

name

ruleThenEnumArg2Name

public static java.lang.String ruleThenEnumArg2Name()

full rule then enum arg2 name

Returns:

name

ruleIfConditionEnumName

public static java.lang.String ruleIfConditionEnumName()

full rule if condition enum name

Returns:

name

ruleIfConditionEnumArg0Name

public static java.lang.String ruleIfConditionEnumArg0Name()

full rule if condition enum arg0 name

Returns:

name

ruleIfConditionEnumArg1Name

public static java.lang.String ruleIfConditionEnumArg1Name()

full rule if condition enum arg1 name

Returns:

name

ruleIfConditionElName

public static java.lang.String ruleIfConditionElName()

full rule ruleIfConditionElName

Returns:

name

ruleIfOwnerNameName

public static java.lang.String ruleIfOwnerNameName()

full ruleIfOwnerName

Returns:

name

ruleCheckOwnerNameName

public static java.lang.String ruleCheckOwnerNameName()

full ruleCheckOwnerName

Returns:

name

ruleCheckStemScopeName

public static java.lang.String ruleCheckStemScopeName()

full ruleCheckStemScope

Returns:

name

ruleCheckOwnerIdName

public static java.lang.String ruleCheckOwnerIdName()

full ruleCheckOwnerIdName

Returns:

name

ruleCheckArg0Name

public static java.lang.String ruleCheckArg0Name()

full ruleCheckArg0Name

Returns:

name

ruleCheckArg1Name

public static java.lang.String ruleCheckArg1Name()

full ruleCheckArg1Name

Returns:

name

ruleIfOwnerIdName

public static java.lang.String ruleIfOwnerIdName()

full ruleIfOwnerIdName

Returns:

name

ruleIfStemScopeName

public static java.lang.String ruleIfStemScopeName()

full ruleIfStemScopeName

Returns:

name

ruleCheckTypeName

public static java.lang.String ruleCheckTypeName()

full ruleCheckTypeName

Returns:

name

ruleActAsSubjectSourceIdName

public static java.lang.String ruleActAsSubjectSourceIdName()

full ruleActAsSubjectSourceIdName

Returns:

name

ruleActAsSubjectIdentifierName

public static java.lang.String ruleActAsSubjectIdentifierName()

full rule then el name

Returns:

name

ruleActAsSubjectIdName

public static java.lang.String ruleActAsSubjectIdName()

full ruleActAsSubjectIdName

Returns:

name

group

public static Group group(java.lang.String groupId,
                          java.lang.String groupName,
                          java.lang.String alternateGroupId,
                          boolean useRootSession,
                          boolean throwExceptionIfNotFound)

Parameters:

groupId -

groupName -

alternateGroupId -

useRootSession - if we should use root or static session

throwExceptionIfNotFound -

Returns:

group or null

stem

public static Stem stem(java.lang.String stemId,
                        java.lang.String stemName,
                        java.lang.String alternateStemId,
                        boolean useRootSession,
                        boolean throwExceptionIfNotFound)

Parameters:

stemId -

stemName -

alternateStemId -

useRootSession - if we should use root or static session

throwExceptionIfNotFound -

Returns:

stem or null

attributeDef

public static AttributeDef attributeDef(java.lang.String attributeDefId,
                                        java.lang.String attributeDefName,
                                        java.lang.String alternateAttributeDefId,
                                        boolean useRootSession,
                                        boolean throwExceptionIfNotFound)

Parameters:

attributeDefId -

attributeDefName -

alternateAttributeDefId -

useRootSession - if we should use root or static session

throwExceptionIfNotFound -

Returns:

attributeDef or null

validateGroup

public static java.lang.String validateGroup(java.lang.String groupId,
                                             java.lang.String groupName,
                                             java.lang.String alternateGroupId)

Parameters:

groupId -

groupName -

alternateGroupId -

Returns:

the error message or null if ok

validateStem

public static java.lang.String validateStem(java.lang.String stemId,
                                            java.lang.String stemName,
                                            java.lang.String alternateStemId)

Parameters:

stemId -

stemName -

alternateStemId -

Returns:

the error message or null if ok

validateAttributeDef

public static java.lang.String validateAttributeDef(java.lang.String attributeDefId,
                                                    java.lang.String attributeDefName,
                                                    java.lang.String alternateAttributeDefId)

Parameters:

attributeDefId -

attributeDefName -

alternateAttributeDefId -

Returns:

the error message or null if ok