com.salesforce.androidsdk.rest

Class RestClient.ClientInfo

java.lang.Object

com.salesforce.androidsdk.rest.RestClient.ClientInfo

Direct Known Subclasses:

RestClient.UnauthenticatedClientInfo

Enclosing class:

RestClient

public static class RestClient.ClientInfo
extends java.lang.Object

All immutable information for an authenticated client (e.g. username, org ID, etc.). TODO revisit this class - some of information is NOT immutable e.g. sids

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	accountName
java.util.Map<java.lang.String,java.lang.String>	additionalOauthValues
java.lang.String	communityId
java.lang.String	communityUrl
java.lang.String	contentDomain
java.lang.String	contentSid
java.lang.String	csrfToken
java.lang.String	displayName
java.lang.String	email
java.lang.String	firstName
java.net.URI	identityUrl
java.net.URI	instanceUrl
java.lang.String	lastName
java.lang.String	lightningDomain
java.lang.String	lightningSid
java.net.URI	loginUrl
java.lang.String	orgId
java.lang.String	photoUrl
java.lang.String	thumbnailUrl
java.lang.String	userId
java.lang.String	username
java.lang.String	vfDomain
java.lang.String	vfSid

Constructor Summary

Constructors

Constructor and Description

ClientInfo(java.net.URI instanceUrl, java.net.URI loginUrl, java.net.URI identityUrl, java.lang.String accountName, java.lang.String username, java.lang.String userId, java.lang.String orgId, java.lang.String communityId, java.lang.String communityUrl, java.lang.String firstName, java.lang.String lastName, java.lang.String displayName, java.lang.String email, java.lang.String photoUrl, java.lang.String thumbnailUrl, java.util.Map<java.lang.String,java.lang.String> additionalOauthValues, java.lang.String lightningDomain, java.lang.String lightningSid, java.lang.String vfDomain, java.lang.String vfSid, java.lang.String contentDomain, java.lang.String contentSid, java.lang.String csrfToken) Parameterized constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildUniqueId()
java.net.URI	getInstanceUrl() Returns a URI representation of the instance URL.
java.lang.String	getInstanceUrlAsString() Returns a string representation of the instance URL.
java.net.URI	resolveUrl(RestRequest request) Resolves the given RestRequest to its URL.
java.net.URI	resolveUrl(java.lang.String path) Resolves the given path against the community URL or the instance URL, depending on whether the user is a community user or not.
java.net.URI	resolveUrl(java.lang.String path, RestRequest.RestEndpoint endpoint) Resolves the given path against the community URL, login URL, or instance URL.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

instanceUrl

public final java.net.URI instanceUrl

loginUrl

public final java.net.URI loginUrl

identityUrl

public final java.net.URI identityUrl

accountName

public final java.lang.String accountName

username

public final java.lang.String username

userId

public final java.lang.String userId

orgId

public final java.lang.String orgId

communityId

public final java.lang.String communityId

communityUrl

public final java.lang.String communityUrl

firstName

public final java.lang.String firstName

lastName

public final java.lang.String lastName

displayName

public final java.lang.String displayName

email

public final java.lang.String email

photoUrl

public final java.lang.String photoUrl

thumbnailUrl

public final java.lang.String thumbnailUrl

lightningDomain

public final java.lang.String lightningDomain

lightningSid

public final java.lang.String lightningSid

vfDomain

public final java.lang.String vfDomain

vfSid

public final java.lang.String vfSid

contentDomain

public final java.lang.String contentDomain

contentSid

public final java.lang.String contentSid

csrfToken

public final java.lang.String csrfToken

additionalOauthValues

public final java.util.Map<java.lang.String,java.lang.String> additionalOauthValues

Constructor Detail

ClientInfo

public ClientInfo(java.net.URI instanceUrl,
                  java.net.URI loginUrl,
                  java.net.URI identityUrl,
                  java.lang.String accountName,
                  java.lang.String username,
                  java.lang.String userId,
                  java.lang.String orgId,
                  java.lang.String communityId,
                  java.lang.String communityUrl,
                  java.lang.String firstName,
                  java.lang.String lastName,
                  java.lang.String displayName,
                  java.lang.String email,
                  java.lang.String photoUrl,
                  java.lang.String thumbnailUrl,
                  java.util.Map<java.lang.String,java.lang.String> additionalOauthValues,
                  java.lang.String lightningDomain,
                  java.lang.String lightningSid,
                  java.lang.String vfDomain,
                  java.lang.String vfSid,
                  java.lang.String contentDomain,
                  java.lang.String contentSid,
                  java.lang.String csrfToken)

Parameterized constructor.

Parameters:

instanceUrl - Instance URL.

loginUrl - Login URL.

identityUrl - Identity URL.

accountName - Account name.

username - User name.

userId - User ID.

orgId - Org ID.

communityId - Community ID.

communityUrl - Community URL.

firstName - First Name.

lastName - LastName.

displayName - DisplayName.

email - Email.

photoUrl - Photo URL.

thumbnailUrl - Thumbnail URL.

additionalOauthValues - Additional OAuth values.

lightningDomain - Lightning domain.

lightningSid - Lightning SID.

vfDomain - VF domain.

vfSid - VF SID.

contentDomain - Content domain.

contentSid - Content SID.

csrfToken - CSRF token.

Method Detail

buildUniqueId

public java.lang.String buildUniqueId()

Returns:

unique id built from user id and org id

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getInstanceUrlAsString

public java.lang.String getInstanceUrlAsString()

Returns a string representation of the instance URL. If this is a community user, the community URL will be returned. If not, the instance URL will be returned.

Returns:

Instance URL.

getInstanceUrl

public java.net.URI getInstanceUrl()

Returns a URI representation of the instance URL. If this is a community user, the community URL will be returned. If not, the instance URL will be returned.

Returns:

Instance URL.

resolveUrl

public java.net.URI resolveUrl(RestRequest request)

Resolves the given RestRequest to its URL.

Parameters:

request - The Rest request to resolve.

Returns:

The URI associated with the Rest request.

resolveUrl

public java.net.URI resolveUrl(java.lang.String path)

Resolves the given path against the community URL or the instance URL, depending on whether the user is a community user or not.

Parameters:

path - Path.

Returns:

Resolved URL.

resolveUrl

public java.net.URI resolveUrl(java.lang.String path,
                               RestRequest.RestEndpoint endpoint)

Resolves the given path against the community URL, login URL, or instance URL. If the user is a community user, the community URL will be used. Otherwise, the URL will be built from the RestRequest.RestEndpoint parameter.

Parameters:

path - Path

endpoint - The Rest endpoint of the URL.

Returns:

Resolved URL.