OAuthPermission (Apache CXF JavaDoc 3.1.0 API)

Apache CXF API

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.cxf.rs.security.oauth2.common.Permission
- - org.apache.cxf.rs.security.oauth2.common.OAuthPermission

All Implemented Interfaces:

Serializable
```
public class OAuthPermission
extends Permission
```
Provides the complete information about a given opaque permission. For example, a scope parameter such as "read_calendar" will be translated into the instance of this class in order to provide the human readable description and optionally restrict it to a limited set of HTTP verbs and request URIs

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

OAuthPermission()

OAuthPermission(String permission, String description)

Method Summary

Methods
Modifier and Type	Method and Description
`List<String>`	`getHttpVerbs()` Gets the optional list of HTTP verbs
`List<String>`	`getUris()` Gets the optional list of relative request URIs
`void`	`setHttpVerbs(List<String> httpVerbs)` Sets the optional list of HTTP verbs, example, "GET" and "POST", etc
`void`	`setUris(List<String> uri)` Sets the optional list of relative request URIs

Methods inherited from class org.apache.cxf.rs.security.oauth2.common.Permission
getDescription, getPermission, isDefault, setDefault, setDescription, setPermission

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

- Constructor Detail
  - OAuthPermission
```
public OAuthPermission()
```
  - OAuthPermission
```
public OAuthPermission(String permission,
               String description)
```
- Method Detail
  - setHttpVerbs
```
public void setHttpVerbs(List<String> httpVerbs)
```
    Sets the optional list of HTTP verbs, example, "GET" and "POST", etc
    
    Parameters:
    httpVerbs - the list of HTTP verbs
  - getHttpVerbs
```
public List<String> getHttpVerbs()
```
    Gets the optional list of HTTP verbs
    
    Returns:
    the list of HTTP verbs
  - setUris
```
public void setUris(List<String> uri)
```
    Sets the optional list of relative request URIs
    
    Parameters:
    uri - the list of URIs
  - getUris
```
public List<String> getUris()
```
    Gets the optional list of relative request URIs
    
    Returns:
    the list of URIs

Apache CXF API

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Apache CXF