01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.metadata;
23:
24: import org.w3c.dom.Element;
25:
26: import org.jboss.deployment.DeploymentException;
27:
28: /** The metadata object for the security-role-ref element.
29: The security-role-ref element contains the declaration of a security
30: role reference in the enterprise bean’s code. The declaration con-sists
31: of an optional description, the security role name used in the
32: code, and an optional link to a defined security role.
33: The value of the role-name element must be the String used as the
34: parameter to the EJBContext.isCallerInRole(String roleName) method.
35: The value of the role-link element must be the name of one of the
36: security roles defined in the security-role elements.
37:
38: Used in: entity and session
39:
40: * @author <a href="mailto:sebastien.alborini@m4x.org">Sebastien Alborini</a>
41: * @author <a href="mailto:Scott_Stark@displayscape.com">Scott Stark</a>.
42: * @version $Revision: 57209 $
43: */
44: public class SecurityRoleRefMetaData extends MetaData {
45: // Constants -----------------------------------------------------
46:
47: // Attributes ----------------------------------------------------
48: private String name;
49: private String link;
50: private String description;
51:
52: // Static --------------------------------------------------------
53:
54: // Constructors --------------------------------------------------
55: public SecurityRoleRefMetaData() {
56: }
57:
58: // Public --------------------------------------------------------
59:
60: public String getName() {
61: return name;
62: }
63:
64: public String getLink() {
65: return link;
66: }
67:
68: public String getDescription() {
69: return description;
70: }
71:
72: public void importEjbJarXml(Element element)
73: throws DeploymentException {
74: name = getElementContent(getUniqueChild(element, "role-name"));
75: link = getElementContent(getOptionalChild(element, "role-link"));
76: description = getElementContent(getOptionalChild(element,
77: "description"));
78: }
79:
80: }
|