SalResponse

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Communications Service Broker
SAL API Reference Reference
Release 6.0
E26227-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.convergin.common.sal.ext.api
Interface SalResponse

All Superinterfaces:: java.lang.Cloneable, SalMessage

public interface SalResponse

extends SalMessage

Represents SAL responses. Instances of this class are passed to SalApplication when the container receives incoming SAL responses and also, SalApplications acting as UA servers or proxies generates SAL responses of their own by creating SalResponses.

SAL responses has a three-digit status code that indicates the outcome of the corresponding request. Responses with a status code in the range of 100-199 (1xx's) are called provisional or informational and indicate progress in processing of the request. Any response with a status code of 200 or higher is a final response. A UA server may send only one final response per request but this may be preceeded by any number of provisional responses.

2xx responses indicate a successful outcome while 3xx-6xx indicate a variety of non-success conditions.

The summary of status codes is [RFC 3261]:

1xx: Informational -- request received, continuing to process the request
2xx: Success -- the action was successfully received, understood, and accepted
3xx: Redirection -- further action needs to be taken in order to complete the request
4xx: Client Error -- the request contains bad syntax or cannot be fulfilled at this server
5xx: Server Error -- the server failed to fulfill an apparently valid request
6xx: Global Failure -- the request cannot be fulfilled at any server

Field Summary
`static int`	`SC_ACCEPTED` The status code has the same meaning as in JSR 289
`static int`	`SC_ADDRESS_INCOMPLETE` The status code has the same meaning as in JSR 289
`static int`	`SC_ALTERNATIVE_SERVICE` The status code has the same meaning as in JSR 289
`static int`	`SC_AMBIGUOUS` The status code has the same meaning as in JSR 289
`static int`	`SC_BAD_EVENT` The status code has the same meaning as in JSR 289
`static int`	`SC_BAD_EXTENSION` The status code has the same meaning as in JSR 289
`static int`	`SC_BAD_GATEWAY` The status code has the same meaning as in JSR 289
`static int`	`SC_BAD_IDENTITY_INFO` The status code has the same meaning as in JSR 289
`static int`	`SC_BAD_REQUEST` The status code has the same meaning as in JSR 289
`static int`	`SC_BUSY_EVERYWHERE` The status code has the same meaning as in JSR 289
`static int`	`SC_BUSY_HERE` The status code has the same meaning as in JSR 289
`static int`	`SC_CALL_BEING_FORWARDED` The status code has the same meaning as in JSR 289
`static int`	`SC_CALL_LEG_DONE` The status code has the same meaning as in JSR 289
`static int`	`SC_CALL_QUEUED` The status code has the same meaning as in JSR 289
`static int`	`SC_CONDITIONAL_REQUEST_FAILED` The status code has the same meaning as in JSR 289
`static int`	`SC_DECLINE` The status code has the same meaning as in JSR 289
`static int`	`SC_DOES_NOT_EXIT_ANYWHERE` The status code has the same meaning as in JSR 289
`static int`	`SC_EXTENSION_REQUIRED` The status code has the same meaning as in JSR 289
`static int`	`SC_FORBIDDEN` The status code has the same meaning as in JSR 289
`static int`	`SC_GONE` The status code has the same meaning as in JSR 289
`static int`	`SC_INTERVAL_TOO_BRIEF` The status code has the same meaning as in JSR 289
`static int`	`SC_INVALID_IDENTITY_HEADER` The status code has the same meaning as in JSR 289
`static int`	`SC_LOOP_DETECTED` The status code has the same meaning as in JSR 289
`static int`	`SC_MESSAGE_TOO_LARGE` The status code has the same meaning as in JSR 289
`static int`	`SC_METHOD_NOT_ALLOWED` The status code has the same meaning as in JSR 289
`static int`	`SC_MOVED_PERMANENTLY` The status code has the same meaning as in JSR 289
`static int`	`SC_MOVED_TEMPORARILY` The status code has the same meaning as in JSR 289
`static int`	`SC_MULTIPLE_CHOICES` The status code has the same meaning as in JSR 289
`static int`	`SC_NOT_ACCEPTABLE` The status code has the same meaning as in JSR 289
`static int`	`SC_NOT_ACCEPTABLE_ANYWHERE` The status code has the same meaning as in JSR 289
`static int`	`SC_NOT_ACCEPTABLE_HERE` The status code has the same meaning as in JSR 289
`static int`	`SC_NOT_FOUND` The status code has the same meaning as in JSR 289
`static int`	`SC_NOT_IMPLEMENTED` The status code has the same meaning as in JSR 289
`static int`	`SC_OK` The status code has the same meaning as in JSR 289
`static int`	`SC_PAYMENT_REQUIRED` The status code has the same meaning as in JSR 289
`static int`	`SC_PRECONDITION_FAILURE` The status code has the same meaning as in JSR 289
`static int`	`SC_PROVIDE_REFERER_IDENTITY` The status code has the same meaning as in JSR 289
`static int`	`SC_PROXY_AUTHENTICATION_REQUIRED` The status code has the same meaning as in JSR 289
`static int`	`SC_REQUEST_ENTITY_TOO_LARGE` The status code has the same meaning as in JSR 289
`static int`	`SC_REQUEST_PENDING` The status code has the same meaning as in JSR 289
`static int`	`SC_REQUEST_TERMINATED` The status code has the same meaning as in JSR 289
`static int`	`SC_REQUEST_TIMEOUT` The status code has the same meaning as in JSR 289
`static int`	`SC_REQUEST_URI_TOO_LONG` The status code has the same meaning as in JSR 289
`static int`	`SC_RINGING` The status code has the same meaning as in JSR 289
`static int`	`SC_SECURITY_AGREEMENT_REQUIRED` The status code has the same meaning as in JSR 289
`static int`	`SC_SERVER_INTERNAL_ERROR` The status code has the same meaning as in JSR 289
`static int`	`SC_SERVER_TIMEOUT` The status code has the same meaning as in JSR 289
`static int`	`SC_SERVICE_UNAVAILABLE` The status code has the same meaning as in JSR 289
`static int`	`SC_SESSION_INTERVAL_TOO_SMALL` The status code has the same meaning as in JSR 289
`static int`	`SC_SESSION_PROGRESS` The status code has the same meaning as in JSR 289
`static int`	`SC_TEMPORARLY_UNAVAILABLE` The status code has the same meaning as in JSR 289
`static int`	`SC_TOO_MANY_HOPS` The status code has the same meaning as in JSR 289
`static int`	`SC_TRYING` The status code has the same meaning as in JSR 289
`static int`	`SC_UNAUTHORIZED` The status code has the same meaning as in JSR 289
`static int`	`SC_UNDECIPHERABLE` The status code has the same meaning as in JSR 289
`static int`	`SC_UNSUPPORTED_CERTIFICATE` The status code has the same meaning as in JSR 289
`static int`	`SC_UNSUPPORTED_MEDIA_TYPE` The status code has the same meaning as in JSR 289
`static int`	`SC_UNSUPPORTED_URI_SCHEME` The status code has the same meaning as in JSR 289
`static int`	`SC_USE_IDENTITY_HEADER` The status code has the same meaning as in JSR 289
`static int`	`SC_USE_PROXY` The status code has the same meaning as in JSR 289
`static int`	`SC_VERSION_NOT_SUPPORTED` The status code has the same meaning as in JSR 289

Method Summary
`SalRequest`	`createAck()` Returns an ACK request object corresponding to this response.
`SalRequest`	`createPrack()` Creates a PRACK request object corresponding to this response.
`java.lang.String`	`getReasonPhrase()` Returns the reason phrase for this response object.
`SalRequest`	`getRequest()` Returns the request associated with this response.
`int`	`getStatus()` Returns the status code of this response object.
`void`	`send()` Causes this response to be sent.
`void`	`setStatus(int responseCode)` Sets the status code of this response object.
`void`	`setStatus(int responseCode, java.lang.String reasonPhrase)` Sets the status code and reason phrase of this response object

Methods inherited from interface com.convergin.common.sal.ext.api.SalMessage
`addAddressHeader, addHeader, getAddressHeader, getAddressHeaders, getApplicationSession, getApplicationSession, getContent, getContentType, getFrom, getHeader, getHeaderNames, getHeaders, getMethod, getSession, getSession, getTo, removeHeader, setAddressHeader, setContent, setContentType, setHeader`

Field Detail