org.gedcomx.rs.client

Class GedcomxApplicationState<E>

java.lang.Object

org.gedcomx.rs.client.GedcomxApplicationState<E>

Direct Known Subclasses:

AgentState, AncestryResultsState, CollectionsState, CollectionState, DescendancyResultsState, PersonChildrenState, PersonParentsState, PersonSearchResultsState, PersonSpousesState, PersonsState, PersonState, PlaceDescriptionsState, PlaceDescriptionState, RecordsState, RecordState, RelationshipsState, RelationshipState, SourceDescriptionsState, SourceDescriptionState, VocabElementListState, VocabElementState

public abstract class GedcomxApplicationState<E>
extends Object

Author:

Ryan Heaton

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accessToken
protected com.sun.jersey.api.client.Client	client
protected static EmbeddedLinkLoader	DEFAULT_EMBEDDED_LINK_LOADER
protected E	entity
protected Map<String,org.gedcomx.links.Link>	links
protected com.sun.jersey.api.client.ClientRequest	request
protected com.sun.jersey.api.client.ClientResponse	response
protected StateFactory	stateFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GedcomxApplicationState(com.sun.jersey.api.client.ClientRequest request, com.sun.jersey.api.client.ClientResponse response, String accessToken, StateFactory stateFactory)

Method Summary

Modifier and Type	Method and Description
protected GedcomxApplicationState	authenticateViaOAuth2(javax.ws.rs.core.MultivaluedMap<String,String> formData, StateTransitionOption... options)
protected GedcomxApplicationState	authenticateViaOAuth2AuthCode(String authCode, String redirect, String clientId)
protected GedcomxApplicationState	authenticateViaOAuth2AuthCode(String authCode, String redirect, String clientId, String clientSecret)
protected GedcomxApplicationState	authenticateViaOAuth2ClientCredentials(String clientId, String clientSecret)
protected GedcomxApplicationState	authenticateViaOAuth2Password(String username, String password, String clientId)
protected GedcomxApplicationState	authenticateViaOAuth2Password(String username, String password, String clientId, String clientSecret)
protected GedcomxApplicationState	authenticateWithAccessToken(String accessToken)
protected String	buildFailureMessage()
protected abstract GedcomxApplicationState	clone(com.sun.jersey.api.client.ClientRequest request, com.sun.jersey.api.client.ClientResponse response)
protected com.sun.jersey.api.client.ClientRequest.Builder	createAuthenticatedFeedRequest()
protected com.sun.jersey.api.client.ClientRequest.Builder	createAuthenticatedGedcomxRequest()
protected com.sun.jersey.api.client.ClientRequest.Builder	createAuthenticatedRequest()
protected com.sun.jersey.api.client.ClientRequest.Builder	createRequest()
protected com.sun.jersey.api.client.ClientRequest.Builder	createRequestForEmbeddedResource(String rel)
GedcomxApplicationState	delete(StateTransitionOption... options)
protected void	embed(org.gedcomx.links.Link link, org.gedcomx.Gedcomx entity, StateTransitionOption... options)
protected void	embed(List<org.gedcomx.links.Link> links, org.gedcomx.Gedcomx entity, StateTransitionOption... options)
GedcomxApplicationState	get(StateTransitionOption... options)
String	getAccessToken()
com.sun.jersey.api.client.Client	getClient()
org.gedcomx.source.SourceDescription	getDescription()
protected EmbeddedLinkLoader	getEmbeddedLinkLoader()
E	getEntity()
javax.ws.rs.core.EntityTag	getETag()
javax.ws.rs.core.MultivaluedMap<String,String>	getHeaders()
com.sun.jersey.api.client.ClientRequest	getLastEmbeddedRequest()
com.sun.jersey.api.client.ClientResponse	getLastEmbeddedResponse()
Date	getLastModified()
org.gedcomx.links.Link	getLink(String rel)
List<org.gedcomx.links.Link>	getLinks()
protected abstract org.gedcomx.links.SupportsLinks	getMainDataElement()
com.sun.jersey.api.client.ClientRequest	getRequest()
com.sun.jersey.api.client.ClientResponse	getResponse()
String	getSelfRel()
URI	getSelfUri()
URI	getUri()
List<HttpWarning>	getWarnings()
boolean	hasClientError()
boolean	hasError()
boolean	hasServerError()
boolean	hasStatus(com.sun.jersey.api.client.ClientResponse.Status status)
GedcomxApplicationState	head(StateTransitionOption... options)
GedcomxApplicationState	ifSuccessful()
protected void	includeEmbeddedResources(org.gedcomx.Gedcomx entity, StateTransitionOption... options)
GedcomxApplicationState	inject(com.sun.jersey.api.client.ClientRequest request)
protected com.sun.jersey.api.client.ClientResponse	invoke(com.sun.jersey.api.client.ClientRequest request, StateTransitionOption... options)
boolean	isAuthenticated()
boolean	isEmbeddedLinkLoaded(String rel)
protected abstract E	loadEntity(com.sun.jersey.api.client.ClientResponse response)
protected E	loadEntityConditionally(com.sun.jersey.api.client.ClientResponse response)
protected List<org.gedcomx.links.Link>	loadLinks(com.sun.jersey.api.client.ClientResponse response, E entity)
GedcomxApplicationState	options(StateTransitionOption... options)
GedcomxApplicationState	post(E entity, StateTransitionOption... options)
GedcomxApplicationState	put(E entity, StateTransitionOption... options)
AgentState	readContributor(org.gedcomx.common.Attributable attributable, StateTransitionOption... options)
AgentState	readContributor(org.gedcomx.common.ResourceReference contributor, StateTransitionOption... options)
AgentState	readContributor(StateTransitionOption... options)
protected GedcomxApplicationState	readFirstPage(StateTransitionOption... options)
protected GedcomxApplicationState	readLastPage(StateTransitionOption... options)
protected GedcomxApplicationState	readNextPage(StateTransitionOption... options)
protected GedcomxApplicationState	readPage(String rel, StateTransitionOption... options)
protected GedcomxApplicationState	readPreviousPage(StateTransitionOption... options)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EMBEDDED_LINK_LOADER

protected static final EmbeddedLinkLoader DEFAULT_EMBEDDED_LINK_LOADER

stateFactory

protected final StateFactory stateFactory

links

protected final Map<String,org.gedcomx.links.Link> links

client

protected final com.sun.jersey.api.client.Client client

request

protected final com.sun.jersey.api.client.ClientRequest request

response

protected final com.sun.jersey.api.client.ClientResponse response

entity

protected final E entity

accessToken

protected String accessToken

Constructor Detail

GedcomxApplicationState

protected GedcomxApplicationState(com.sun.jersey.api.client.ClientRequest request,
                                  com.sun.jersey.api.client.ClientResponse response,
                                  String accessToken,
                                  StateFactory stateFactory)

Method Detail

loadEntityConditionally

protected E loadEntityConditionally(com.sun.jersey.api.client.ClientResponse response)

inject

public GedcomxApplicationState inject(com.sun.jersey.api.client.ClientRequest request)

clone

protected abstract GedcomxApplicationState clone(com.sun.jersey.api.client.ClientRequest request,
                                                 com.sun.jersey.api.client.ClientResponse response)

loadEntity

protected abstract E loadEntity(com.sun.jersey.api.client.ClientResponse response)

getMainDataElement

protected abstract org.gedcomx.links.SupportsLinks getMainDataElement()

loadLinks

protected List<org.gedcomx.links.Link> loadLinks(com.sun.jersey.api.client.ClientResponse response,
                                                 E entity)

getClient

public com.sun.jersey.api.client.Client getClient()

getAccessToken

public String getAccessToken()

isAuthenticated

public boolean isAuthenticated()

getRequest

public com.sun.jersey.api.client.ClientRequest getRequest()

getResponse

public com.sun.jersey.api.client.ClientResponse getResponse()

getLastEmbeddedRequest

public com.sun.jersey.api.client.ClientRequest getLastEmbeddedRequest()

getLastEmbeddedResponse

public com.sun.jersey.api.client.ClientResponse getLastEmbeddedResponse()

isEmbeddedLinkLoaded

public boolean isEmbeddedLinkLoaded(String rel)

getEntity

public E getEntity()

getDescription

public org.gedcomx.source.SourceDescription getDescription()

getUri

public URI getUri()

hasClientError

public boolean hasClientError()

hasServerError

public boolean hasServerError()

hasError

public boolean hasError()

hasStatus

public boolean hasStatus(com.sun.jersey.api.client.ClientResponse.Status status)

getETag

public javax.ws.rs.core.EntityTag getETag()

getLastModified

public Date getLastModified()

getHeaders

public javax.ws.rs.core.MultivaluedMap<String,String> getHeaders()

getSelfUri

public URI getSelfUri()

getSelfRel

public String getSelfRel()

head

public GedcomxApplicationState head(StateTransitionOption... options)

get

public GedcomxApplicationState get(StateTransitionOption... options)

delete

public GedcomxApplicationState delete(StateTransitionOption... options)

options

public GedcomxApplicationState options(StateTransitionOption... options)

put

public GedcomxApplicationState put(E entity,
                                   StateTransitionOption... options)

post

public GedcomxApplicationState post(E entity,
                                    StateTransitionOption... options)

getWarnings

public List<HttpWarning> getWarnings()

getLink

public org.gedcomx.links.Link getLink(String rel)

getLinks

public List<org.gedcomx.links.Link> getLinks()

ifSuccessful

public GedcomxApplicationState ifSuccessful()

buildFailureMessage

protected String buildFailureMessage()

authenticateViaOAuth2Password

protected GedcomxApplicationState authenticateViaOAuth2Password(String username,
                                                                String password,
                                                                String clientId)

authenticateViaOAuth2Password

protected GedcomxApplicationState authenticateViaOAuth2Password(String username,
                                                                String password,
                                                                String clientId,
                                                                String clientSecret)

authenticateViaOAuth2AuthCode

protected GedcomxApplicationState authenticateViaOAuth2AuthCode(String authCode,
                                                                String redirect,
                                                                String clientId)

authenticateViaOAuth2AuthCode

protected GedcomxApplicationState authenticateViaOAuth2AuthCode(String authCode,
                                                                String redirect,
                                                                String clientId,
                                                                String clientSecret)

authenticateViaOAuth2ClientCredentials

protected GedcomxApplicationState authenticateViaOAuth2ClientCredentials(String clientId,
                                                                         String clientSecret)

authenticateWithAccessToken

protected GedcomxApplicationState authenticateWithAccessToken(String accessToken)

authenticateViaOAuth2

protected GedcomxApplicationState authenticateViaOAuth2(javax.ws.rs.core.MultivaluedMap<String,String> formData,
                                                        StateTransitionOption... options)

readPage

protected GedcomxApplicationState readPage(String rel,
                                           StateTransitionOption... options)

readNextPage

protected GedcomxApplicationState readNextPage(StateTransitionOption... options)

readPreviousPage

protected GedcomxApplicationState readPreviousPage(StateTransitionOption... options)

readFirstPage

protected GedcomxApplicationState readFirstPage(StateTransitionOption... options)

readLastPage

protected GedcomxApplicationState readLastPage(StateTransitionOption... options)

createAuthenticatedFeedRequest

protected com.sun.jersey.api.client.ClientRequest.Builder createAuthenticatedFeedRequest()

createAuthenticatedGedcomxRequest

protected com.sun.jersey.api.client.ClientRequest.Builder createAuthenticatedGedcomxRequest()

invoke

protected com.sun.jersey.api.client.ClientResponse invoke(com.sun.jersey.api.client.ClientRequest request,
                                                          StateTransitionOption... options)

createRequest

protected com.sun.jersey.api.client.ClientRequest.Builder createRequest()

createAuthenticatedRequest

protected com.sun.jersey.api.client.ClientRequest.Builder createAuthenticatedRequest()

includeEmbeddedResources

protected void includeEmbeddedResources(org.gedcomx.Gedcomx entity,
                                        StateTransitionOption... options)

embed

protected void embed(List<org.gedcomx.links.Link> links,
                     org.gedcomx.Gedcomx entity,
                     StateTransitionOption... options)

getEmbeddedLinkLoader

protected EmbeddedLinkLoader getEmbeddedLinkLoader()

embed

protected void embed(org.gedcomx.links.Link link,
                     org.gedcomx.Gedcomx entity,
                     StateTransitionOption... options)

createRequestForEmbeddedResource

protected com.sun.jersey.api.client.ClientRequest.Builder createRequestForEmbeddedResource(String rel)

readContributor

public AgentState readContributor(StateTransitionOption... options)

readContributor

public AgentState readContributor(org.gedcomx.common.Attributable attributable,
                                  StateTransitionOption... options)

readContributor

public AgentState readContributor(org.gedcomx.common.ResourceReference contributor,
                                  StateTransitionOption... options)