AbstractProtocolResponse (Shibboleth IdP :: CAS Protocol API 4.1.1 API)

java.lang.Object
- net.shibboleth.idp.cas.protocol.AbstractProtocolResponse

Direct Known Subclasses:

ProxyTicketResponse, TicketValidationResponse
```
public class AbstractProtocolResponse
extends Object
```
Abstract base class for protocol response messages.

Since:

3.2.0

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`errorCode`	CAS protocol error code populated on failure.
`private String`	`errorDetail`	CAS protocol error detail populated on failure.

Constructor Summary

Constructors
Constructor Description

AbstractProtocolResponse()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getErrorCode()`	Get the non-null error code on a ticket validation failure condition.
`String`	`getErrorDetail()`	Get the non-null error detail on a ticket validation failure condition.
`void`	`setErrorCode(String code)`	Set the non-null error code on a ticket validation failure condition.
`void`	`setErrorDetail(String code)`	Set the non-null error detail on a ticket validation failure condition.

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

- Field Detail
  - errorCode
```
@Nullable
private String errorCode
```
    CAS protocol error code populated on failure.
  - errorDetail
```
@Nullable
private String errorDetail
```
    CAS protocol error detail populated on failure.
- Constructor Detail
  - AbstractProtocolResponse
```
public AbstractProtocolResponse()
```
- Method Detail
  - getErrorCode
```
@Nullable
public String getErrorCode()
```
    Get the non-null error code on a ticket validation failure condition.
    
    Returns:
    
    non-null error code on a ticket validation failure condition
  - setErrorCode
```
public void setErrorCode(@Nonnull
                         String code)
```
    Set the non-null error code on a ticket validation failure condition.
    
    Parameters:
    
    code - non-null error code on a ticket validation failure condition
  - getErrorDetail
```
@Nullable
public String getErrorDetail()
```
    Get the non-null error detail on a ticket validation failure condition.
    
    Returns:
    
    non-null error detail on a ticket validation failure condition
  - setErrorDetail
```
public void setErrorDetail(@Nonnull
                           String code)
```
    Set the non-null error detail on a ticket validation failure condition.
    
    Parameters:
    
    code - non-null error detail on a ticket validation failure condition