| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF 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 |
| * |
| * https://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.apache.directory.fortress.core.model; |
| |
| |
| import java.util.ArrayList; |
| import java.util.Enumeration; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Properties; |
| import java.util.Set; |
| import java.util.UUID; |
| |
| import jakarta.xml.bind.annotation.XmlAccessType; |
| import jakarta.xml.bind.annotation.XmlAccessorType; |
| import jakarta.xml.bind.annotation.XmlRootElement; |
| import jakarta.xml.bind.annotation.XmlSeeAlso; |
| import jakarta.xml.bind.annotation.XmlTransient; |
| import jakarta.xml.bind.annotation.XmlType; |
| |
| |
| /** |
| * All entities ({@link User}, {@link Role}, {@link org.apache.directory.fortress.core.model.Permission}, |
| * {@link org.apache.directory.fortress.core.model.PwPolicy} {@link SDSet} etc...) are used to carry data between three |
| * Fortress layers.starting with the (1) Manager layer down thru middle (2) Process layer and it's processing rules into |
| * (3) DAO layer where persistence with the LDAP server occurs. |
| * <h3></h3> |
| * <h4>Fortress Processing Layers</h4> |
| * <ol> |
| * <li> |
| * Manager layer: {@link org.apache.directory.fortress.core.impl.AdminMgrImpl}, |
| * {@link org.apache.directory.fortress.core.impl.AccessMgrImpl}, |
| * {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl},... |
| * </li> |
| * <li> |
| * Process layer: {@link org.apache.directory.fortress.core.impl.UserP}, |
| * {@link org.apache.directory.fortress.core.impl.RoleP}, {@link org.apache.directory.fortress.core.impl.PermP},... |
| * </li> |
| * <li> |
| * DAO layer: {@link org.apache.directory.fortress.core.impl.UserDAO}, |
| * {@link org.apache.directory.fortress.core.impl.RoleDAO}, {@link org.apache.directory.fortress.core.impl.PermDAO},... |
| * </li> |
| * </ol> |
| * Fortress clients first instantiate and populate a data entity before invoking any of the Manager APIs. The caller must |
| * provide enough information to uniquely identity the entity target within ldap.<br> |
| * For example, this entity requires {@link #setName} attribute set before passing into |
| * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl} APIs. Create methods sometimes require more attributes |
| * (than Read) due to constraints enforced between entities although only {@link Role#setName} is required for {@link Role}. |
| * <p> |
| * <h4>Role entity attribute usages include</h4> |
| * <ul> |
| * <li> |
| * {@link #setName} attribute must be set before calling |
| * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#addRole(Role)}, |
| * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#updateRole(Role)} or |
| * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#deleteRole(Role)} |
| * </li> |
| * <li> |
| * {@link Constraint} may be set <b>before</b> calling method |
| * {@link org.apache.directory.fortress.core.impl.AdminMgrImpl#addRole(Role)}. |
| * </li> |
| * <li> |
| * {@link Constraint} will be <b>returned</b> to caller on methods like |
| * {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl#readRole(Role)} or |
| * {@link org.apache.directory.fortress.core.impl.ReviewMgrImpl#findRoles(String)} if persisted to entity prior to call. |
| * </li> |
| * </ul> |
| * <p> |
| * This entity is used to store the RBAC Role assignments that comprise the many-to-many relationships between {@link User}s |
| * and {@link org.apache.directory.fortress.core.model.Permission}s. |
| * <br> |
| * The unique key to locate a Role entity (which is subsequently assigned both to Users and Permissions) is 'Role.name'. |
| * <br> |
| * <p> |
| * There is a many-to-many relationship between User's, RBAC Roles and Permissions. |
| * <h3>{@link User}*<->*{@link Role}*<->*{@link org.apache.directory.fortress.core.model.Permission}</h3> |
| * <p> |
| * <img src="../doc-files/RbacCore.png" alt=""> |
| * <p> |
| * Example to create new RBAC Role: |
| * <pre> |
| * try |
| * { |
| * // Instantiate the AdminMgr first |
| * AdminMgr adminMgr = AdminMgrFactory.createInstance(); |
| * |
| * Role myRole = new Role("MyRoleName"); |
| * myRole.setDescription("This is a test role"); |
| * adminMgr.addRole(myRole); |
| * } |
| * catch (SecurityException ex) |
| * { |
| * // log or throw |
| * } |
| * </pre> |
| * The above code will persist to LDAP a Role object that can be used as a target for User-Role assignments and |
| * Role-Permission grants. |
| * <p> |
| * <h4>Role Schema</h4> |
| * The Fortress Role entity is a composite of the following other Fortress structural and aux object classes: |
| * <p> |
| * 1. organizationalRole Structural Object Class is used to store basic attributes like cn and description. |
| * <pre> |
| * ------------------------------------------ |
| * objectclass ( 2.5.6.8 NAME 'organizationalRole' |
| * DESC 'RFC2256: an organizational role' |
| * SUP top STRUCTURAL |
| * MUST cn |
| * MAY ( |
| * x121Address $ registeredAddress $ destinationIndicator $ |
| * preferredDeliveryMethod $ telexNumber $ teletexTerminalIdentifier $ |
| * telephoneNumber $ internationaliSDNNumber $ facsimileTelephoneNumber $ |
| * seeAlso $ roleOccupant $ preferredDeliveryMethod $ street $ |
| * postOfficeBox $ postalCode $ postalAddress $ |
| * physicalDeliveryOfficeName $ ou $ st $ l $ description |
| * ) |
| * ) |
| * ------------------------------------------ |
| * </pre> |
| * <p> |
| * 2. ftRls Structural objectclass is used to store the Role information like name and temporal constraint attributes. |
| * <pre> |
| * ------------------------------------------ |
| * Fortress Roles Structural Object Class |
| * objectclass ( 1.3.6.1.4.1.38088.2.1 |
| * NAME 'ftRls' |
| * DESC 'Fortress Role Structural Object Class' |
| * SUP organizationalrole |
| * STRUCTURAL |
| * MUST ( |
| * ftId $ |
| * ftRoleName |
| * ) |
| * MAY ( |
| * description $ |
| * ftCstr $ |
| * ftParents |
| * ) |
| * ) |
| * ------------------------------------------ |
| * </pre> |
| * <p> |
| * 3. ftProperties AUXILIARY Object Class is used to store client specific name/value pairs on target entity.<br> |
| * <code># This aux object class can be used to store custom attributes.</code><br> |
| * <code># The properties collections consist of name/value pairs and are not constrainted by Fortress.</code><br> |
| * <pre> |
| * ------------------------------------------ |
| * AC2: Fortress Properties Auxiliary Object Class |
| * objectclass ( 1.3.6.1.4.1.38088.3.2 |
| * NAME 'ftProperties' |
| * DESC 'Fortress Properties AUX Object Class' |
| * AUXILIARY |
| * MAY ( |
| * ftProps |
| * ) |
| * ) |
| * ------------------------------------------ |
| * </pre> |
| * <p> |
| * 4. ftMods AUXILIARY Object Class is used to store Fortress audit variables on target entity. |
| * <pre> |
| * ------------------------------------------ |
| * Fortress Audit Modification Auxiliary Object Class |
| * objectclass ( 1.3.6.1.4.1.38088.3.4 |
| * NAME 'ftMods' |
| * DESC 'Fortress Modifiers AUX Object Class' |
| * AUXILIARY |
| * MAY ( |
| * ftModifier $ |
| * ftModCode $ |
| * ftModId |
| * ) |
| * ) |
| * ------------------------------------------ |
| * </pre> |
| * <p> |
| * |
| * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> |
| */ |
| @XmlRootElement(name = "fortRole") |
| @XmlAccessorType(XmlAccessType.FIELD) |
| @XmlType(name = "role", propOrder = |
| { |
| "name", |
| "id", |
| "description", |
| "parents", |
| "children", |
| "beginDate", |
| "beginLockDate", |
| "beginTime", |
| "dayMask", |
| "endDate", |
| "endLockDate", |
| "endTime", |
| "timeout", |
| "dn", |
| "gidNumber", |
| "props" |
| }) |
| @XmlSeeAlso( |
| { |
| AdminRole.class |
| }) |
| public class Role extends FortEntity implements Constraint, Graphable, java.io.Serializable |
| { |
| private static final long serialVersionUID = 1L; |
| private String id; // this maps to ftId |
| private String name; // this is ftRoleName |
| private String description; // this is description |
| private String dn; // this attribute is automatically saved to each ldap record. |
| @XmlTransient |
| private List<String> occupants; |
| private Set<String> parents; |
| private Set<String> children; |
| private String beginTime; // this attribute is ftCstr |
| private String endTime; // this attribute is ftCstr |
| private String beginDate; // this attribute is ftCstr |
| private String endDate; // this attribute is ftCstr |
| private String beginLockDate;// this attribute is ftCstr |
| private String endLockDate; // this attribute is ftCstr |
| private String dayMask; // this attribute is ftCstr |
| private String gidNumber; |
| private int timeout; // this attribute is ftCstr |
| private Props props = new Props(); |
| |
| |
| /** |
| * Default constructor is used by internal Fortress classes. |
| */ |
| public Role() |
| { |
| } |
| |
| |
| /** |
| * Construct a Role entity with a given name. |
| * |
| * @param name maps to 'cn' attribute on 'organizationalrole' object class. |
| */ |
| public Role( String name ) |
| { |
| this.name = name; |
| } |
| |
| |
| /** |
| * Construct an RBAC Role with a given temporal constraint. |
| * |
| * @param con maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| public Role( Constraint con ) |
| { |
| ConstraintUtil.copy( con, this ); |
| } |
| |
| |
| /** |
| * Required on DAO classes convert Temporal attributes stored on entity to raw data object format needed for ldap. For internal use only. |
| * |
| * @return String that maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| public String getRawData() |
| { |
| return rawData; |
| } |
| |
| |
| /** |
| * Required on DAO classes convert Temporal from raw ldap data to entity attributes. For internal use only. |
| * |
| * @param rawData maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| public void setRawData( String rawData ) |
| { |
| this.rawData = rawData; |
| } |
| |
| // Do not ship over http. |
| private transient String rawData; |
| |
| |
| /** |
| * Gets the name required attribute of the Role object |
| * |
| * @return attribute maps to 'cn' attribute on 'organizationalrole' object class. |
| */ |
| public String getName() |
| { |
| return name; |
| } |
| |
| |
| /** |
| * Sets the required name attribute on the Role object |
| * |
| */ |
| public void setName( String name ) |
| { |
| this.name = name; |
| } |
| |
| |
| /** |
| * Set the occupant attribute with the contents of the User dn. |
| * @param occupant maps to 'roleOccupant' attribute on 'organizationalrole' object class. |
| */ |
| public void setOccupant( String occupant ) |
| { |
| if ( this.occupants == null ) |
| { |
| this.occupants = new ArrayList<>(); |
| } |
| this.occupants.add( occupant ); |
| } |
| |
| |
| /** |
| * Return list of occupants for a particular Role entity. |
| * @return List of type String containing User dn that maps to 'roleOccupant' attribute on 'organizationalrole' object |
| * class. |
| */ |
| public List<String> getOccupants() |
| { |
| return occupants; |
| } |
| |
| |
| /** |
| * Set a list of occupants for a particular Role entity. |
| * @param occupants contains a List of type String which maps to 'roleOccupant' attribute on 'organizationalrole' |
| * object class. |
| */ |
| public void setOccupants( List<String> occupants ) |
| { |
| this.occupants = occupants; |
| } |
| |
| |
| /** |
| * Returns optional description that is associated with Role. This attribute is validated but not constrained by |
| * Fortress. |
| * |
| * @return value that is mapped to 'description' in 'organizationalrole' object class. |
| */ |
| public String getDescription() |
| { |
| return this.description; |
| } |
| |
| |
| /** |
| * Sets the optional description that is associated with Role. This attribute is validated but not constrained by |
| * Fortress. |
| * |
| * @param description that is mapped to same name in 'organizationalrole' object class. |
| */ |
| public void setDescription( String description ) |
| { |
| this.description = description; |
| } |
| |
| |
| /** |
| * Return the internal id that is associated with Role. This attribute is generated automatically |
| * by Fortress when new Role is added to directory and is not known or changeable by external client. |
| * |
| * @return attribute maps to 'ftId' in 'ftRls' object class. |
| */ |
| public String getId() |
| { |
| return id; |
| } |
| |
| |
| /** |
| * Generate an internal Id that is associated with Role. This method is used by DAO class and |
| * is not available to outside classes. The generated attribute maps to 'ftId' in 'ftRls' object class. |
| */ |
| public void setId() |
| { |
| // generate a unique id: |
| UUID uuid = UUID.randomUUID(); |
| this.id = uuid.toString(); |
| } |
| |
| |
| /** |
| * Set the internal Id that is associated with Role. This method is used by DAO class and |
| * is generated automatically by Fortress. Attribute stored in LDAP cannot be changed by external caller. |
| * This method can be used by client for search purposes only. |
| * |
| * @param id maps to 'ftId' in 'ftRls' object class. |
| */ |
| public void setId( String id ) |
| { |
| this.id = id; |
| } |
| |
| |
| /** |
| * temporal boolean flag is used by internal Fortress components. |
| * |
| * @return boolean indicating if temporal constraints are placed on Role. |
| */ |
| @Override |
| public boolean isTemporalSet() |
| { |
| return ( beginTime != null || endTime != null || beginDate != null || endDate != null || beginLockDate != null |
| || endLockDate != null || dayMask != null ); |
| } |
| |
| |
| /** |
| * Contains the begin time of day Role is allowed to be activated in session. The format is military time - HHMM, |
| * i.e. 0800 (8:00 am) or 1700 (5:00 p.m.). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public String getBeginTime() |
| { |
| return this.beginTime; |
| } |
| |
| |
| /** |
| * Set the begin time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e. |
| * 0800 (8:00 am) or 1700 (5:00 p.m.). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @param beginTime maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public void setBeginTime( String beginTime ) |
| { |
| this.beginTime = beginTime; |
| } |
| |
| |
| /** |
| * Contains the end time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e. |
| * 0000 (12:00 am) or 2359 (11:59 p.m.). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public String getEndTime() |
| { |
| return this.endTime; |
| } |
| |
| |
| /** |
| * Set the end time of day Role is allowed to be activated in session. The format is military time - HHMM, i.e. 0000 |
| * (12:00 am) or 2359 (11:59 p.m.). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @param endTime maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public void setEndTime( String endTime ) |
| { |
| this.endTime = endTime; |
| } |
| |
| |
| /** |
| * Contains the begin date when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101 |
| * (January 1. 2010). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public String getBeginDate() |
| { |
| return this.beginDate; |
| } |
| |
| |
| /** |
| * Set the beginDate when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101 |
| * (January 1. 2010). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @param beginDate maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public void setBeginDate( String beginDate ) |
| { |
| this.beginDate = beginDate; |
| } |
| |
| |
| /** |
| * Contains the end date when Role is allowed to be activated in session. The format is - YYYYMMDD, i.e. 20101231 |
| * (December 31, 2010). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public String getEndDate() |
| { |
| return this.endDate; |
| } |
| |
| |
| /** |
| * Set the end date when Role is not allowed to be activated in session. The format is - YYYYMMDD, i.e. 20100101 |
| * (January 1. 2010). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @param endDate maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public void setEndDate( String endDate ) |
| { |
| this.endDate = endDate; |
| } |
| |
| |
| /** |
| * Contains the begin lock date when Role is temporarily not allowed to be activated in session. The format is - YYMMDD, |
| * i.e. 20100101 (January 1. 2010). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public String getBeginLockDate() |
| { |
| return this.beginLockDate; |
| } |
| |
| |
| /** |
| * Set the begin lock date when Role is temporarily not allowed to be activated in session. The format is - YYYYMMDD, |
| * i.e. 20100101 (January 1. 2010). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @param beginLockDate maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public void setBeginLockDate( String beginLockDate ) |
| { |
| this.beginLockDate = beginLockDate; |
| } |
| |
| |
| /** |
| * Contains the end lock date when Role is allowed to be activated in session once again. The format is - YYYYMMDD, |
| * i.e. 20100101 (January 1. 2010). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public String getEndLockDate() |
| { |
| return this.endLockDate; |
| } |
| |
| |
| /** |
| * Set the end lock date when Role is allowed to be activated in session once again. The format is - YYYYMMDD, i.e. |
| * 20100101 (January 1. 2010). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @param endLockDate maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public void setEndLockDate( String endLockDate ) |
| { |
| this.endLockDate = endLockDate; |
| } |
| |
| |
| /** |
| * Get the daymask that indicates what days of week Role is allowed to be activated in session. The format is 1234567, |
| * i.e. 23456 (Monday, Tuesday, Wednesday, Thursday, Friday). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @return attribute maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public String getDayMask() |
| { |
| return this.dayMask; |
| } |
| |
| |
| /** |
| * Set the daymask that specifies what days of week Role is allowed to be activated in session. The format is 1234567, |
| * i.e. 23456 (Monday, Tuesday, Wednesday, Thursday, Friday). |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @param dayMask maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public void setDayMask( String dayMask ) |
| { |
| this.dayMask = dayMask; |
| } |
| |
| |
| /** |
| * Return the integer timeout that contains total time ((in minutes)) that Role may remain inactive in User's session |
| * before it is deactivated. |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @return int maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public Integer getTimeout() |
| { |
| return this.timeout; |
| } |
| |
| |
| /** |
| * Set the integer timeout that contains max time ((in minutes)) that Role may remain inactive in User's session before it |
| * is deactivated. |
| * This attribute is optional but if set will be validated for reasonableness. |
| * |
| * @param timeout maps to 'ftCstr' attribute in 'ftRls' object class. |
| */ |
| @Override |
| public void setTimeout( Integer timeout ) |
| { |
| this.timeout = timeout; |
| } |
| |
| |
| @Override |
| public List<RoleConstraint> getConstraints() |
| { |
| throw new java.lang.UnsupportedOperationException(); |
| } |
| |
| /** |
| * Get the names of roles that are parents (direct ascendants) of this role. |
| * @return Set of parent role names assigned to this role. |
| */ |
| @Override |
| public Set<String> getParents() |
| { |
| if ( this.parents == null ) |
| { |
| this.parents = new HashSet<>(); |
| } |
| return parents; |
| } |
| |
| |
| /** |
| * Set the names of roles names that are parents (direct ascendants) of this role. |
| * @param parents contains the Set of parent role names assigned to this role. |
| */ |
| @Override |
| public void setParents( Set<String> parents ) |
| { |
| this.parents = parents; |
| } |
| |
| |
| /** |
| * Set the occupant attribute with the contents of the User dn. |
| * @param parent maps to 'ftParents' attribute on 'ftRls' object class. |
| */ |
| @Override |
| public void setParent( String parent ) |
| { |
| if ( this.parents == null ) |
| { |
| this.parents = new HashSet<>(); |
| } |
| this.parents.add( parent ); |
| } |
| |
| |
| /** |
| * Set the occupant attribute with the contents of the User dn. |
| * @param parent maps to 'ftParents' attribute on 'ftRls' object class. |
| */ |
| @Override |
| public void delParent( String parent ) |
| { |
| if ( this.parents != null ) |
| { |
| this.parents.remove( parent ); |
| } |
| } |
| |
| |
| /** |
| * Return the Set of child role names (direct descendants) of this role. |
| * @return Set of child role names assigned to this role. |
| */ |
| public Set<String> getChildren() |
| { |
| return children; |
| } |
| |
| |
| /** |
| * Set the Set of child role names (direct descendants) of this role |
| * @param children contains the Set of child role names assigned to this role. |
| */ |
| public void setChildren( Set<String> children ) |
| { |
| this.children = children; |
| } |
| |
| |
| /** |
| * Returns distinguished name associated with Role. This attribute is generated by DAO and is not allowed for outside classes to modify. |
| * This attribute is for internal use only and need not be processed by external clients. |
| * |
| * @return value that is mapped to the dn of the entry in DIT. |
| */ |
| public String getDn() |
| { |
| return dn; |
| } |
| |
| |
| /** |
| * Set distinguished name associated with Role. This attribute is used by DAO and is not allowed for outside classes. |
| * This attribute cannot be set by external callers. |
| */ |
| public void setDn( String dn ) |
| { |
| this.dn = dn; |
| } |
| |
| |
| /** |
| * Get the Group ID number, which is required attribute for RFC2307 posixGroup object class. |
| * @return |
| */ |
| public String getGidNumber() |
| { |
| return gidNumber; |
| } |
| |
| |
| /** |
| * Set the Group ID nunmber, which is required attribute for RFC2307 posixGroup object class. |
| * @param gidNumber |
| */ |
| public void setGidNumber(String gidNumber) |
| { |
| this.gidNumber = gidNumber; |
| } |
| |
| |
| /** |
| * Matches the name from two Role entities. |
| * |
| * @param thatObj contains a Role entity. |
| * @return boolean indicating both objects contain matching Role names. |
| */ |
| public boolean equals( Object thatObj ) |
| { |
| if ( this == thatObj ) |
| { |
| return true; |
| } |
| |
| if ( name == null ) |
| { |
| return false; |
| } |
| |
| if ( !( thatObj instanceof Role ) ) |
| { |
| return false; |
| } |
| |
| Role thatRole = ( Role ) thatObj; |
| |
| if ( thatRole.getName() == null ) |
| { |
| return false; |
| } |
| |
| return thatRole.getName().equalsIgnoreCase( name ); |
| } |
| |
| |
| @Override |
| public int hashCode() |
| { |
| int result = id != null ? id.hashCode() : 0; |
| result = 31 * result + ( name != null ? name.hashCode() : 0 ); |
| result = 31 * result + ( description != null ? description.hashCode() : 0 ); |
| result = 31 * result + ( dn != null ? dn.hashCode() : 0 ); |
| result = 31 * result + ( occupants != null ? occupants.hashCode() : 0 ); |
| result = 31 * result + ( parents != null ? parents.hashCode() : 0 ); |
| result = 31 * result + ( children != null ? children.hashCode() : 0 ); |
| result = 31 * result + ( beginTime != null ? beginTime.hashCode() : 0 ); |
| result = 31 * result + ( endTime != null ? endTime.hashCode() : 0 ); |
| result = 31 * result + ( beginDate != null ? beginDate.hashCode() : 0 ); |
| result = 31 * result + ( endDate != null ? endDate.hashCode() : 0 ); |
| result = 31 * result + ( beginLockDate != null ? beginLockDate.hashCode() : 0 ); |
| result = 31 * result + ( endLockDate != null ? endLockDate.hashCode() : 0 ); |
| result = 31 * result + ( dayMask != null ? dayMask.hashCode() : 0 ); |
| result = 31 * result + timeout; |
| result = 31 * result + ( rawData != null ? rawData.hashCode() : 0 ); |
| return result; |
| } |
| |
| |
| /** |
| * @see Object#toString() |
| * |
| * @param tabs the spaces to put at the beginning of each line for a correct indentation |
| * @return The representation of a Role as a String |
| */ |
| protected String toString( String tabs ) |
| { |
| StringBuilder sb = new StringBuilder(); |
| |
| sb.append( tabs ).append( "Role[" ); |
| |
| // The name |
| sb.append( name ).append( ", " ); |
| |
| if ( ( description != null ) && ( description.length() > 0 ) ) |
| { |
| sb.append( description ).append( ", " ); |
| } |
| |
| // the date |
| sb.append( "date : <" ).append( beginDate ).append( ", " ).append( endDate ).append( ">, " ); |
| |
| // The time |
| sb.append( "time : <" ).append( beginTime ).append( ", " ).append( endTime ).append( ">, " ); |
| |
| // The lock date |
| sb.append( "lock date : <" ).append( beginLockDate ).append( ", " ).append( endLockDate ).append( ">, " ); |
| |
| // The timeout |
| sb.append( "timeout : " ).append( timeout ).append( ", " ); |
| |
| // The day mask |
| sb.append( "daymask : " ).append( dayMask ); |
| |
| // The parents if any |
| if ( ( parents != null ) && ( parents.size() > 0 ) ) |
| { |
| sb.append( ", parents : {" ); |
| |
| boolean isFirst = true; |
| |
| for ( String parent : parents ) |
| { |
| if ( isFirst ) |
| { |
| isFirst = false; |
| } |
| else |
| { |
| sb.append( '|' ); |
| } |
| |
| sb.append( parent ); |
| } |
| |
| sb.append( '}' ); |
| } |
| |
| // The children if any |
| if ( ( children != null ) && ( children.size() > 0 ) ) |
| { |
| sb.append( ", children : {" ); |
| |
| boolean isFirst = true; |
| |
| for ( String child : children ) |
| { |
| if ( isFirst ) |
| { |
| isFirst = false; |
| } |
| else |
| { |
| sb.append( '|' ); |
| } |
| |
| sb.append( child ); |
| } |
| |
| sb.append( '}' ); |
| } |
| |
| sb.append( ']' ); |
| |
| return sb.toString(); |
| } |
| |
| |
| /** |
| * @see Object#toString() |
| */ |
| public String toString() |
| { |
| return toString( "" ); |
| } |
| |
| /** |
| * Add name/value pair to list of properties associated with User. These values are not constrained by Fortress. |
| * Properties are optional. |
| * |
| * @param key contains property name and maps to 'ftProps' attribute in 'ftProperties' aux object class. |
| * @param value The property value to add |
| */ |
| private void addProperty( String key, String value ) |
| { |
| Props.Entry entry = new Props.Entry(); |
| entry.setKey( key ); |
| entry.setValue( value ); |
| props.getEntry().add( entry ); |
| } |
| |
| /** |
| * Add new collection of name/value pairs to attributes associated with User. These values are not constrained by Fortress. |
| * Properties are optional. |
| * |
| * @param props contains collection of name/value pairs and maps to 'ftProps' attribute in 'ftProperties' aux object class. |
| */ |
| public void addProperties( Properties props ) |
| { |
| if ( props != null ) |
| { |
| for ( Enumeration<?> e = props.propertyNames(); e.hasMoreElements(); ) |
| { |
| // This LDAP attr is stored as a name-value pair separated by a ':'. |
| String key = ( String ) e.nextElement(); |
| String val = props.getProperty( key ); |
| addProperty( key, val ); |
| } |
| } |
| } |
| |
| /** |
| * Return the collection of name/value pairs to attributes associated with User. These values are not constrained by Fortress. |
| * Properties are optional. |
| * |
| * @return Properties contains collection of name/value pairs and maps to 'ftProps' attribute in 'ftProperties' aux object class. |
| */ |
| public Properties getProperties() |
| { |
| Properties properties = null; |
| List<Props.Entry> props = this.props.getEntry(); |
| |
| if ( props.size() > 0 ) |
| { |
| properties = new Properties(); |
| |
| for ( Props.Entry entry : props ) |
| { |
| String key = entry.getKey(); |
| String val = entry.getValue(); |
| properties.setProperty( key, val ); |
| } |
| } |
| |
| return properties; |
| } |
| } |
