Package com.redwood.scheduler.api.model

Interface LDAPProfile

    • Method Detail

      • isActive

        boolean isActive()
        Get the value for Active. (Declares whether the profile is currently active)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getProfileName

        String getProfileName()
        Get the value for ProfileName. (The name given to an LDAP profile) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getLDAPServerType

        LDAPServerType getLDAPServerType()
        Get the value for LDAPServerType. (The type of LDAP server. ) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getConnectionURL

        String getConnectionURL()
        Get the value for ConnectionURL. (The same as the java.naming.provider.url or the Tomcat JNDIRealm connectionURL e.g. ldap://192.168.7.245:389) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getConnectionUserName

        String getConnectionUserName()
        Get the value for ConnectionUserName. (The is same as the java.naming.security.principal or the Tomcat JNDIRealm connectionName e.g. Administrator@example.com This is not always required because connections can be anonymous depending on which LDAP server is accessed. )
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getConnectionPassword

        String getConnectionPassword()
        Get the value for ConnectionPassword. (The is same as the java.naming.security.credentials or the Tomcat JNDIRealm connectionPassword This is not always required because connections can be anonymous depending on which LDAP server is accessed. )
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getBaseDN

        String getBaseDN()
        Get the value for BaseDN. (The start point in the LDAP tree. ) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUserSearchBase

        String getUserSearchBase()
        Get the value for UserSearchBase. (The point in the LDAP tree from which to perform the user search. Same as the Tomcat JNDIRealm userBase e.g. CN=Users,DC=example,DC=com )
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUserMailField

        String getUserMailField()
        Get the value for UserMailField. (The LDAP user-attribute that holds the users email address e.g. mail)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUserNameField

        String getUserNameField()
        Get the value for UserNameField. (The LDAP user-attribute that holds the users login name e.g. cn/uid)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUserDNExpression

        String getUserDNExpression()
        Get the value for UserDNExpression. (The expression used to construct the users DN e.g. cn=${userName},CN=Users,DC=example,DC=com)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUserExactSearchExpression

        String getUserExactSearchExpression()
        Get the value for UserExactSearchExpression. (The search expression used as the search filter e.g. cn=${userName} or uid=${userName})
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getGroupNameField

        String getGroupNameField()
        Get the value for GroupNameField. (The LDAP group-attribute that holds name of the user roles e.g. cn/uid)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getGroupMemberField

        String getGroupMemberField()
        Get the value for GroupMemberField. (The LDAP group-attribute that holds the user names that have membership of that group e.g. member)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getGroupSearchBase

        String getGroupSearchBase()
        Get the value for GroupSearchBase. (The point in the LDAP tree from which to perform the group search. Same as the Tomcat JNDIRealm roleBase e.g. CN=Users,DC=example,DC=com )
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getGroupSearchExpression

        String getGroupSearchExpression()
        Get the value for GroupSearchExpression. (The search expression to find the users roles e.g. (member=cn=${userName},CN=Users,DC=example,DC=com) )
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUserRole

        String getUserRole()
        Get the value for UserRole. (The LDAP group that represents the scheduler-user role e.g. Users)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getAdminRole

        String getAdminRole()
        Get the value for AdminRole. (The LDAP group that represents the scheduler-administrator role e.g. Administrators)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getIsolationAdminRole

        String getIsolationAdminRole()
        Get the value for IsolationAdminRole. (The LDAP group that represents the scheduler-isolation-administrator role e.g. GroupAdministrators)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getScreenReaderRole

        @Deprecated
String getScreenReaderRole()
        Deprecated.
        This field is deprecated, use Subject.ScreenReader instead.

        Get the value for ScreenReaderRole. (This field is deprecated. The LDAP group that represents the scheduler-screen-reader role e.g. ScreenReaders)

        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getITUserRole

        String getITUserRole()
        Get the value for ITUserRole. (The LDAP group that represents the scheduler-it-user role e.g. ITUsers )
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getBusinessUserRole

        String getBusinessUserRole()
        Get the value for BusinessUserRole. (The LDAP group that represents the scheduler-business-user role e.g. BusinessUsers )
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getBAEUserRole

        String getBAEUserRole()
        Get the value for BAEUserRole. (The LDAP group that represents the scheduler-bae-only-user role e.g. BaeOnlyUsers )
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getSearchScope

        String getSearchScope()
        Get the value for SearchScope. (The javax.naming.directory.SearchControls value for user searches e.g. SUBTREE/ONELEVEL/OBJECT)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setActive

        void setActive​(boolean newActive)
        Set the value for Active. (Declares whether the profile is currently active)
        Parameters:
        newActive - the new value for Active.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setProfileName

        void setProfileName​(String newProfileName)
        Set the value for ProfileName. (The name given to an LDAP profile) This value is mandatory.
        Parameters:
        newProfileName - the new value for ProfileName. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setLDAPServerType

        void setLDAPServerType​(LDAPServerType newLDAPServerType)
        Set the value for LDAPServerType. (The type of LDAP server. ) This value is mandatory.
        Parameters:
        newLDAPServerType - the new value for LDAPServerType. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setConnectionURL

        void setConnectionURL​(String newConnectionURL)
        Set the value for ConnectionURL. (The same as the java.naming.provider.url or the Tomcat JNDIRealm connectionURL e.g. ldap://192.168.7.245:389) This value is mandatory.
        Parameters:
        newConnectionURL - the new value for ConnectionURL. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setConnectionUserName

        void setConnectionUserName​(String newConnectionUserName)
        Set the value for ConnectionUserName. (The is same as the java.naming.security.principal or the Tomcat JNDIRealm connectionName e.g. Administrator@example.com This is not always required because connections can be anonymous depending on which LDAP server is accessed. ) This value is optional.
        Parameters:
        newConnectionUserName - the new value for ConnectionUserName.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setConnectionPassword

        void setConnectionPassword​(String newConnectionPassword)
        Set the value for ConnectionPassword. (The is same as the java.naming.security.credentials or the Tomcat JNDIRealm connectionPassword This is not always required because connections can be anonymous depending on which LDAP server is accessed. ) This value is optional.
        Parameters:
        newConnectionPassword - the new value for ConnectionPassword.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setBaseDN

        void setBaseDN​(String newBaseDN)
        Set the value for BaseDN. (The start point in the LDAP tree. ) This value is mandatory.
        Parameters:
        newBaseDN - the new value for BaseDN. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setUserSearchBase

        void setUserSearchBase​(String newUserSearchBase)
        Set the value for UserSearchBase. (The point in the LDAP tree from which to perform the user search. Same as the Tomcat JNDIRealm userBase e.g. CN=Users,DC=example,DC=com ) This value is optional.
        Parameters:
        newUserSearchBase - the new value for UserSearchBase.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setUserMailField

        void setUserMailField​(String newUserMailField)
        Set the value for UserMailField. (The LDAP user-attribute that holds the users email address e.g. mail) This value is optional.
        Parameters:
        newUserMailField - the new value for UserMailField.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setUserNameField

        void setUserNameField​(String newUserNameField)
        Set the value for UserNameField. (The LDAP user-attribute that holds the users login name e.g. cn/uid) This value is optional.
        Parameters:
        newUserNameField - the new value for UserNameField.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setUserDNExpression

        void setUserDNExpression​(String newUserDNExpression)
        Set the value for UserDNExpression. (The expression used to construct the users DN e.g. cn=${userName},CN=Users,DC=example,DC=com) This value is optional.
        Parameters:
        newUserDNExpression - the new value for UserDNExpression.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setUserExactSearchExpression

        void setUserExactSearchExpression​(String newUserExactSearchExpression)
        Set the value for UserExactSearchExpression. (The search expression used as the search filter e.g. cn=${userName} or uid=${userName}) This value is optional.
        Parameters:
        newUserExactSearchExpression - the new value for UserExactSearchExpression.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setGroupNameField

        void setGroupNameField​(String newGroupNameField)
        Set the value for GroupNameField. (The LDAP group-attribute that holds name of the user roles e.g. cn/uid) This value is optional.
        Parameters:
        newGroupNameField - the new value for GroupNameField.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setGroupMemberField

        void setGroupMemberField​(String newGroupMemberField)
        Set the value for GroupMemberField. (The LDAP group-attribute that holds the user names that have membership of that group e.g. member) This value is optional.
        Parameters:
        newGroupMemberField - the new value for GroupMemberField.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setGroupSearchBase

        void setGroupSearchBase​(String newGroupSearchBase)
        Set the value for GroupSearchBase. (The point in the LDAP tree from which to perform the group search. Same as the Tomcat JNDIRealm roleBase e.g. CN=Users,DC=example,DC=com ) This value is optional.
        Parameters:
        newGroupSearchBase - the new value for GroupSearchBase.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setGroupSearchExpression

        void setGroupSearchExpression​(String newGroupSearchExpression)
        Set the value for GroupSearchExpression. (The search expression to find the users roles e.g. (member=cn=${userName},CN=Users,DC=example,DC=com) ) This value is optional.
        Parameters:
        newGroupSearchExpression - the new value for GroupSearchExpression.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setUserRole

        void setUserRole​(String newUserRole)
        Set the value for UserRole. (The LDAP group that represents the scheduler-user role e.g. Users) This value is optional.
        Parameters:
        newUserRole - the new value for UserRole.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setAdminRole

        void setAdminRole​(String newAdminRole)
        Set the value for AdminRole. (The LDAP group that represents the scheduler-administrator role e.g. Administrators) This value is optional.
        Parameters:
        newAdminRole - the new value for AdminRole.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setIsolationAdminRole

        void setIsolationAdminRole​(String newIsolationAdminRole)
        Set the value for IsolationAdminRole. (The LDAP group that represents the scheduler-isolation-administrator role e.g. GroupAdministrators) This value is optional.
        Parameters:
        newIsolationAdminRole - the new value for IsolationAdminRole.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setScreenReaderRole

        @Deprecated
void setScreenReaderRole​(String newScreenReaderRole)
        Deprecated.
        This field is deprecated, use Subject.ScreenReader instead.

        Set the value for ScreenReaderRole. (This field is deprecated. The LDAP group that represents the scheduler-screen-reader role e.g. ScreenReaders) This value is optional.

        Parameters:
        newScreenReaderRole - the new value for ScreenReaderRole.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setITUserRole

        void setITUserRole​(String newITUserRole)
        Set the value for ITUserRole. (The LDAP group that represents the scheduler-it-user role e.g. ITUsers ) This value is optional.
        Parameters:
        newITUserRole - the new value for ITUserRole.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setBusinessUserRole

        void setBusinessUserRole​(String newBusinessUserRole)
        Set the value for BusinessUserRole. (The LDAP group that represents the scheduler-business-user role e.g. BusinessUsers ) This value is optional.
        Parameters:
        newBusinessUserRole - the new value for BusinessUserRole.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setBAEUserRole

        void setBAEUserRole​(String newBAEUserRole)
        Set the value for BAEUserRole. (The LDAP group that represents the scheduler-bae-only-user role e.g. BaeOnlyUsers ) This value is optional.
        Parameters:
        newBAEUserRole - the new value for BAEUserRole.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setSearchScope

        void setSearchScope​(String newSearchScope)
        Set the value for SearchScope. (The javax.naming.directory.SearchControls value for user searches e.g. SUBTREE/ONELEVEL/OBJECT) This value is optional.
        Parameters:
        newSearchScope - the new value for SearchScope.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.