View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.security.auth;
35  
36  import java.io.Serializable;
37  import java.security.Principal;
38  
39  
40  /**
41   * A user entity. Defines some standard properties as user name or language.
42   */
43  @Deprecated
44  public interface Entity extends Principal, Serializable {
45  
46      public static final String FULL_NAME = "fullName";
47  
48      public static final String NAME = "name";
49  
50      public static final String EMAIL = "email";
51  
52      public static final String LANGUAGE = "language";
53  
54      public static final String LOCALE = "locale";
55  
56      public static final String ADDRESS_LINE = "address";
57  
58      public static final String PASSWORD = "password";
59  
60      /**
61       * @return the name of the entity, or a default value if no name was set.
62       */
63      @Override
64      public String getName();
65  
66      /**
67       * @deprecated since 5.3.3 not used - use addProperty(Entity.NAME)
68       */
69      @Deprecated
70      public void setName(String name);
71  
72      public void addProperty(String key, Object value);
73  
74      /**
75       * @return the property's value, or null if undefined
76       */
77      public Object getProperty(String key);
78  }