Package com.janeirodigital.sai.core.agents

Class AgentRegistry

java.lang.Object

com.janeirodigital.sai.core.resources.ReadableResource

com.janeirodigital.sai.core.resources.CRUDResource

com.janeirodigital.sai.core.agents.AgentRegistry

public class AgentRegistry
extends CRUDResource

Modifiable instantiation of an Agent Registry

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AgentRegistry.ApplicationRegistrationList<T>	Class for access and iteration of ApplicationRegistrations.
static class	AgentRegistry.Builder	Builder for AgentRegistry instances.
static class	AgentRegistry.SocialAgentRegistrationList<T>	Class for access and iteration of SocialAgentRegistrations.

Field Summary

Fields inherited from class com.janeirodigital.sai.core.resources.ReadableResource

contentType, dataset, exists, httpClient, jsonLdContext, resource, saiSession, unprotected, uri

Constructor Summary

Constructors

Constructor	Description
AgentRegistry(AgentRegistry.Builder builder)	Construct an AgentRegistry instance from the provided AgentRegistry.Builder.

Method Summary

Modifier and Type	Method	Description
void	add(AgentRegistration registration)	Add a SocialAgentRegistration or ApplicationRegistration to the AgentRegistry
static AgentRegistry	get(URI uri, SaiSession saiSession)	Call get(URI, SaiSession, ContentType) without specifying a desired content type for retrieval
static AgentRegistry	get(URI uri, SaiSession saiSession, com.janeirodigital.sai.httputils.ContentType contentType)	Get an AgentRegistry at the provided uri
boolean	isEmpty()	Indicate whether the AgentRegistry has any registrations
AgentRegistry	reload()	Reload a new instance of AgentRegistry using the attributes of the current instance
void	remove(AgentRegistration registration)	Remove an AgentRegistration from the AgentRegistry

Methods inherited from class com.janeirodigital.sai.core.resources.CRUDResource

delete, update

Methods inherited from class com.janeirodigital.sai.core.resources.ReadableResource

checkReadableResponse, read

Methods inherited from class java.lang.Object

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

Constructor Details

AgentRegistry

public AgentRegistry(AgentRegistry.Builder builder)
              throws SaiException

Construct an AgentRegistry instance from the provided AgentRegistry.Builder.

Parameters:

builder - AgentRegistry.Builder to construct with

Throws:

SaiException

Method Details

get

public static AgentRegistry get(URI uri,
 SaiSession saiSession,
 com.janeirodigital.sai.httputils.ContentType contentType)
                         throws SaiException,
com.janeirodigital.sai.httputils.SaiHttpNotFoundException

Get an AgentRegistry at the provided uri

Parameters:

uri - URI of the AgentRegistry to get

saiSession - SaiSession to assign

contentType - ContentType to use

Returns:

Retrieved AgentRegistry

Throws:

SaiException

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

get

public static AgentRegistry get(URI uri,
 SaiSession saiSession)
                         throws com.janeirodigital.sai.httputils.SaiHttpNotFoundException,
SaiException

Call get(URI, SaiSession, ContentType) without specifying a desired content type for retrieval

Parameters:

uri - URI of the AgentRegistry

saiSession - SaiSession to assign

Returns:

Throws:

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

SaiException

reload

public AgentRegistry reload()
                     throws com.janeirodigital.sai.httputils.SaiHttpNotFoundException,
SaiException

Reload a new instance of AgentRegistry using the attributes of the current instance

Returns:

Reloaded AgentRegistry

Throws:

com.janeirodigital.sai.httputils.SaiHttpNotFoundException

SaiException

isEmpty

public boolean isEmpty()

Indicate whether the AgentRegistry has any registrations

Returns:

true if there are not registrations

add

public void add(AgentRegistration registration)
         throws SaiAlreadyExistsException

Add a SocialAgentRegistration or ApplicationRegistration to the AgentRegistry

Parameters:

registration - AgentRegistration to add

Throws:

SaiAlreadyExistsException

remove

public void remove(AgentRegistration registration)

Remove an AgentRegistration from the AgentRegistry

Parameters:

registration - AgentRegistration to remove