Package com.vonage.client.voice

Class SipEndpoint

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.voice.SipEndpoint

All Implemented Interfaces:

Jsonable, Endpoint

public class SipEndpoint
extends JsonableBaseObject
implements Endpoint

Endpoint for connecting to a SIP URI.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SipEndpoint()
	SipEndpoint(String uri)	Creates a new SIP endpoint request.
	SipEndpoint(String uri, String userToUserHeader)	Creates a new SIP endpoint request.
	SipEndpoint(String uri, Map<String,?> headers)	Creates a new SIP endpoint request.
	SipEndpoint(String uri, Map<String,?> headers, String userToUserHeader)	Creates a new SIP endpoint request.

Method Summary

Modifier and Type	Method	Description
Map<String,?>	getHeaders()	Defines custom headers to be sent as part of the SIP INVITE request.
Map<SipHeader,String>	getStandardHeaders()	Headers that are RFC standards, i.e. not prepended with X-.
String	getType()	Endpoint type name.
String	getUri()	SIP URI to connect to.
String	toLog()	Description of the endpoint.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

SipEndpoint

protected SipEndpoint()

SipEndpoint

public SipEndpoint(String uri)

Creates a new SIP endpoint request.

Parameters:

uri - (REQUIRED) SIP URI to connect to.

SipEndpoint

public SipEndpoint(String uri,
 String userToUserHeader)

Creates a new SIP endpoint request.

Parameters:

uri - (REQUIRED) SIP URI to connect to.

userToUserHeader - (OPTIONAL) The User-to-User header, as per RFC 7433.

Since:

8.9.0

SipEndpoint

public SipEndpoint(String uri,
 Map<String,?> headers)

Creates a new SIP endpoint request.

Parameters:

uri - (REQUIRED) URI of the websocket to connect to.

headers - (OPTIONAL) Custom headers to include.

Since:

8.9.0

SipEndpoint

public SipEndpoint(String uri,
 Map<String,?> headers,
 String userToUserHeader)

Creates a new SIP endpoint request.

Parameters:

uri - (REQUIRED) SIP URI to connect to.

headers - (OPTIONAL) Custom headers to include.

userToUserHeader - (OPTIONAL) The User-to-User header, as per RFC 7433.

Since:

8.9.0

Method Details

getUri

public String getUri()

SIP URI to connect to.

Returns:

The SIP URI as a String.

getType

public String getType()

Description copied from interface: Endpoint

Endpoint type name.

Specified by:

getType in interface Endpoint

Returns:

The type of endpoint as a string.

getHeaders

public Map<String,?> getHeaders()

Defines custom headers to be sent as part of the SIP INVITE request. All keys will be prepended with the X- prefix.

Returns:

The custom headers as a Map, or null if unspecified.

Since:

8.9.0

getStandardHeaders

public Map<SipHeader,String> getStandardHeaders()

Headers that are RFC standards, i.e. not prepended with X-.

Returns:

The standard headers, or null if unspecified.

Since:

8.9.0

toLog

public String toLog()

Description copied from interface: Endpoint

Description of the endpoint.

Specified by:

toLog in interface Endpoint

Returns:

String representation of the object.