Method (PingAccess Addon SDK)

java.lang.Object
- com.pingidentity.pa.sdk.http.Method

```
public final class Method
extends Object
```
An immutable HTTP request method.
See: RFC 7231, Section 4

Field Summary

Fields
Modifier and Type	Field and Description
`static Method`	`ACL`
`static Method`	`BASELINE_CONTROL`
`static Method`	`BIND`
`static Method`	`CHECKIN`
`static Method`	`CHECKOUT`
`static Method`	`CONNECT`
`static Method`	`COPY`
`static Method`	`DELETE`
`static Method`	`GET`
`static Method`	`HEAD`
`static Method`	`LABEL`
`static Method`	`LINK`
`static Method`	`LOCK`
`static Method`	`MERGE`
`static Method`	`MKACTIVITY`
`static Method`	`MKCALENDAR`
`static Method`	`MKCOL`
`static Method`	`MKREDIRECTREF`
`static Method`	`MKWORKSPACE`
`static Method`	`MOVE`
`static Method`	`OPTIONS`
`static Method`	`ORDERPATCH`
`static Method`	`PATCH`
`static Method`	`POST`
`static Method`	`PROPFIND`
`static Method`	`PROPPATCH`
`static Method`	`PUT`
`static Method`	`REBIND`
`static Method`	`REPORT`
`static Method`	`SEARCH`
`static Method`	`TRACE`
`static Method`	`UNCHECKOUT`
`static Method`	`UNLINK`
`static Method`	`UNLOCK`
`static Method`	`UPDATE`
`static Method`	`UPDATEREDIRECTREF`
`static Method`	`VERSION_CONTROL`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Method`	`create(String name, boolean safe, boolean idempotent, boolean requestBodyEmpty)` Constructs a new `Method` This constructor is only required to create `Method` instances that are not defined in `Method`.
`boolean`	`equals(Object o)` Two `Method` objects are considered equal when their names are equal using a case-sensitive comparison.
`static Method`	`forName(String name)` Retrieves the `Method` for the supplied name.
`String`	`getName()`
`static Collection<Method>`	`getPredefinedMethods()`
`int`	`hashCode()`
`boolean`	`isIdempotent()` A method is "idempotent" if the client intended either no modification, or a consistent modification.
`boolean`	`isRequestBodyEmpty()` Identifies whether the request body for this method is empty or not.
`boolean`	`isSafe()` A `Method` is "safe" if it is only meant for retrieval.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - GET
```
public static final Method GET
```
  - HEAD
```
public static final Method HEAD
```
  - OPTIONS
```
public static final Method OPTIONS
```
  - TRACE
```
public static final Method TRACE
```
  - PUT
```
public static final Method PUT
```
  - DELETE
```
public static final Method DELETE
```
  - POST
```
public static final Method POST
```
  - CONNECT
```
public static final Method CONNECT
```
  - ACL
```
public static final Method ACL
```
  - BASELINE_CONTROL
```
public static final Method BASELINE_CONTROL
```
  - BIND
```
public static final Method BIND
```
  - CHECKIN
```
public static final Method CHECKIN
```
  - CHECKOUT
```
public static final Method CHECKOUT
```
  - COPY
```
public static final Method COPY
```
  - LABEL
```
public static final Method LABEL
```
  - LINK
```
public static final Method LINK
```
  - LOCK
```
public static final Method LOCK
```
  - MERGE
```
public static final Method MERGE
```
  - MKACTIVITY
```
public static final Method MKACTIVITY
```
  - MKCALENDAR
```
public static final Method MKCALENDAR
```
  - MKCOL
```
public static final Method MKCOL
```
  - MKREDIRECTREF
```
public static final Method MKREDIRECTREF
```
  - MKWORKSPACE
```
public static final Method MKWORKSPACE
```
  - MOVE
```
public static final Method MOVE
```
  - ORDERPATCH
```
public static final Method ORDERPATCH
```
  - PATCH
```
public static final Method PATCH
```
  - PROPFIND
```
public static final Method PROPFIND
```
  - PROPPATCH
```
public static final Method PROPPATCH
```
  - REBIND
```
public static final Method REBIND
```
  - REPORT
```
public static final Method REPORT
```
  - SEARCH
```
public static final Method SEARCH
```
  - UNCHECKOUT
```
public static final Method UNCHECKOUT
```
  - UNLINK
```
public static final Method UNLINK
```
  - UNLOCK
```
public static final Method UNLOCK
```
  - UPDATE
```
public static final Method UPDATE
```
  - UPDATEREDIRECTREF
```
public static final Method UPDATEREDIRECTREF
```
  - VERSION_CONTROL
```
public static final Method VERSION_CONTROL
```
- Method Detail
  - create
```
public static Method create(String name,
                            boolean safe,
                            boolean idempotent,
                            boolean requestBodyEmpty)
```
    Constructs a new Method This constructor is only required to create Method instances that are not defined in Method.
    
    Parameters:
    
    name - the method name. The allowed characters are restricted. See RFC 7230 for the characters allowed in the name.
    
    safe - true if the method is safe. See isSafe()
    
    idempotent - true if the method is idempotent. See isIdempotent()
    
    requestBodyEmpty - true if the associated request body is empty. See isRequestBodyEmpty().
    
    Returns:
    
    the new Method
    
    Throws:
    
    IllegalArgumentException - if the name contains illegal characters. See RFC 7230 for the characters allowed in the name.
  - getName
```
public String getName()
```
    Returns:
    
    the name of this Method
  - isSafe
```
public boolean isSafe()
```
    A Method is "safe" if it is only meant for retrieval. In this case, the client intends no modification on the resource. A safe method is also idempotent, see isIdempotent().
    
    Returns:
    
    true if this Method is safe
    
    See Also:
    
    RFC 7231, Section 4.2.1
  - isIdempotent
```
public boolean isIdempotent()
```
    A method is "idempotent" if the client intended either no modification, or a consistent modification. Repeated successful requests will result in the same effect as a single successful request.
    
    Returns:
    
    true if this method is idempotent
    
    See Also:
    
    RFC 7231, Section 4.2.2
  - isRequestBodyEmpty
```
public boolean isRequestBodyEmpty()
```
    Identifies whether the request body for this method is empty or not.
    
    Returns:
    
    true if the request body for this method is empty
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the method name
  - equals
```
public boolean equals(Object o)
```
    Two Method objects are considered equal when their names are equal using a case-sensitive comparison.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the object to compare
    
    Returns:
    
    true if the specified object equals this Method
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - forName
```
public static Method forName(String name)
```
    Retrieves the Method for the supplied name.
    For example, given the name GET, this method will return GET.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the matching method or null if there is no predefined Method with the specified name.
  - getPredefinedMethods
```
public static Collection<Method> getPredefinedMethods()
```
    Returns:
    
    an unmodifiable Collection of the Method instances defined as fields in this class.

Class Method

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GET

HEAD

OPTIONS

TRACE

PUT

DELETE

POST

CONNECT

ACL

BASELINE_CONTROL

BIND

CHECKIN

CHECKOUT

COPY

LABEL

LINK

LOCK

MERGE

MKACTIVITY

MKCALENDAR

MKCOL

MKREDIRECTREF

MKWORKSPACE

MOVE

ORDERPATCH

PATCH

PROPFIND

PROPPATCH

REBIND

REPORT

SEARCH

UNCHECKOUT

UNLINK

UNLOCK

UPDATE

UPDATEREDIRECTREF

VERSION_CONTROL

Method Detail

create

getName

isSafe

isIdempotent

isRequestBodyEmpty

toString

equals

hashCode

forName

getPredefinedMethods