SecurityRoleMapping (Payara Project 6.2022.1.Alpha3 API)

java.lang.Object
- java.util.Observable
- - org.glassfish.deployment.common.DynamicAttributesDescriptor
  - - org.glassfish.deployment.common.Descriptor
    - - com.sun.enterprise.deployment.runtime.RuntimeDescriptor
      - com.sun.enterprise.deployment.runtime.common.SecurityRoleMapping

All Implemented Interfaces:

Serializable
```
public class SecurityRoleMapping
extends RuntimeDescriptor
```
This is the in memory representation of the security-role-mapping information. Note that we are keeping just the literal Strings in this object. The implementation of Principal is not instantiated here. This is because 1) the dol should avoid loading any classes as the classloaders used for deployment and runtime can be different. 2) verifier uses this information and it has not access to the rolemaper on the server.

Author:

Jerome Dochez

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.sun.enterprise.deployment.runtime.RuntimeDescriptor
  propListeners
- Fields inherited from class org.glassfish.deployment.common.Descriptor
  DESCRIPTION_CHANGED, DESCRIPTOR_CHANGED, docType, LARGE_ICON_CHANGED, NAME_CHANGED, SMALL_ICON_CHANGED

Constructor Summary

Constructors
Constructor Description

SecurityRoleMapping()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addGroupName(String g)`
`void`	`addPrincipalName(PrincipalNameDescriptor p)`
`List<String>`	`getGroupNames()`
`String[]`	`getPrincipalName()`	Deprecated. This method needs to be removed once the custom principal is fully supported.
`List<PrincipalNameDescriptor>`	`getPrincipalNames()`
`String`	`getRoleName()`
`void`	`setRoleName(String name)`

Methods inherited from class com.sun.enterprise.deployment.runtime.RuntimeDescriptor
addPropertyChangeListener, addPropertyChangeListener, addValue, getAttributeValue, getAttributeValue, getAttributeValue, getValue, getValue, getValues, removePropertyChangeListener, removePropertyChangeListener, removeValue, removeValue, setAttributeValue, setAttributeValue, setAttributeValue, setValue, setValue, size

Methods inherited from class org.glassfish.deployment.common.Descriptor
addDescriptorExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDescriptorExtension, getDescriptorExtensions, getDisplayName, getDocType, getLargeIconUri, getLocalizedDescription, getLocalizedDescriptions, getLocalizedDisplayName, getLocalizedDisplayNames, getLocalizedLargeIconUri, getLocalizedLargeIconUris, getLocalizedSmallIconUri, getLocalizedSmallIconUris, getName, getPrefixMapping, getSmallIconUri, isBoundsChecking, print, setBoundsChecking, setDescription, setDisplayName, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, setName, setSmallIconUri, visit

Methods inherited from class org.glassfish.deployment.common.DynamicAttributesDescriptor
addExtraAttribute, getExtraAttribute, getExtraAttributes, removeExtraAttribute, toString

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SecurityRoleMapping
```
public SecurityRoleMapping()
```
- Method Detail
  - getRoleName
```
public String getRoleName()
```
  - setRoleName
```
public void setRoleName(String name)
```
  - getPrincipalNames
```
public List<PrincipalNameDescriptor> getPrincipalNames()
```
  - addPrincipalName
```
public void addPrincipalName(PrincipalNameDescriptor p)
```
  - getGroupNames
```
public List<String> getGroupNames()
```
  - addGroupName
```
public void addGroupName(String g)
```
  - getPrincipalName
```
public String[] getPrincipalName()
```
    Deprecated.
    This method needs to be removed once the custom principal is fully supported. We keep it for now for backward compatiblity in API. Note that this method only returns the name of the principals, not their class-names. Use with caution!