wamblee.org Git - utils/blob - security/usermgt/src/main/java/org/wamblee/security/authentication/Group.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.security.authentication;
  17
  18 import java.io.Serializable;
  19
  20 import javax.persistence.Column;
  21 import javax.persistence.Entity;
  22 import javax.persistence.GeneratedValue;
  23 import javax.persistence.GenerationType;
  24 import javax.persistence.Id;
  25 import javax.persistence.NamedQueries;
  26 import javax.persistence.NamedQuery;
  27 import javax.persistence.Table;
  28 import javax.persistence.Version;
  29
  30 /**
  31  * Represents a group.
  32  *
  33  * @author Erik Brakkee
  34  */
  35 @Entity
  36 @Table(name = "SEC_GROUP")
  37 @NamedQueries( {
  38     @NamedQuery(name = Group.QUERY_FIND_BY_NAME, query = "select g from Group g where g.name = :" +
  39         Group.NAME_PARAM),
  40     @NamedQuery(name = Group.QUERY_COUNT_GROUPS, query = "select count(g) from Group g"),
  41     @NamedQuery(name = Group.QUERY_ALL_GROUPS, query = "select g from Group g") })
  42 public class Group implements Serializable, Comparable {
  43
  44     public static final String QUERY_FIND_BY_NAME = "Group.findByName";
  45     public static final String QUERY_COUNT_GROUPS = "Group.count";
  46     public static final String QUERY_ALL_GROUPS = "Group.all";
  47     public static final String NAME_PARAM = "name";
  48
  49     @Id
  50     @GeneratedValue(strategy = GenerationType.AUTO)
  51     private Long id;
  52
  53     @Version
  54     private int version;
  55
  56     /**
  57      * Group name.
  58      */
  59     @Column(nullable = false, unique = true)
  60     private String name;
  61
  62     /**
  63      * Constructs the group.
  64      *
  65      * @param aName
  66      */
  67     Group(String aName) {
  68         super();
  69         name = aName;
  70     }
  71
  72     /**
  73      * Creates a new Group object.
  74      *
  75      */
  76     public Group(Group aGroup) {
  77         id = aGroup.id;
  78         version = aGroup.version;
  79         name = aGroup.name;
  80     }
  81
  82     /**
  83      * Creates a new Group object.
  84      */
  85     protected Group() {
  86         super();
  87         name = null;
  88     }
  89
  90     /**
  91      * Gets the name of the group.
  92      *
  93      * @return Group name.
  94      */
  95     public String getName() {
  96         return name;
  97     }
  98
  99     /**
 100      * Sets the group name.
 101      *
 102      * @param aName
 103      *            Group name.
 104      */
 105     void setName(String aName) {
 106         name = aName;
 107     }
 108
 109     /*
 110      * (non-Javadoc)
 111      *
 112      * @see java.lang.Object#equals(java.lang.Object)
 113      */
 114     @Override
 115     public boolean equals(Object aGroup) {
 116         if (aGroup == null) {
 117             return false;
 118         }
 119         if (!(aGroup instanceof Group)) {
 120             return false;
 121         }
 122
 123         return name.equals(((Group) aGroup).name);
 124     }
 125
 126     /*
 127      * (non-Javadoc)
 128      *
 129      * @see java.lang.Object#hashCode()
 130      */
 131     @Override
 132     public int hashCode() {
 133         return name.hashCode();
 134     }
 135
 136     /*
 137      * (non-Javadoc)
 138      *
 139      * @see java.lang.Comparable#compareTo(T)
 140      */
 141     public int compareTo(Object aGroup) {
 142         return name.compareTo(((Group) aGroup).name);
 143     }
 144
 145     public Long getPrimaryKey() {
 146         return id;
 147     }
 148
 149     public void setPrimaryKey(Long aKey) {
 150         id = aKey;
 151     }
 152
 153     /*
 154      * (non-Javadoc)
 155      *
 156      * @see java.lang.Object#toString()
 157      */
 158     @Override
 159     public String toString() {
 160         return "Group(pk = " + getPrimaryKey() + ", name=" + name + ")";
 161     }
 162 }