org.talares

Class Talares

java.lang.Object

org.talares.Talares

public class Talares
extends java.lang.Object

Class holding the main client facing API.

An instance of this class should be created to gain access to the API. A cache strategy should be decided upon and a corresponding instance of a subclass of Cache should be provided to the constructor of this class.

Example:

 import org.talares.Talares;
 import org.talares.datatypes.items.Page;
 import play.libs.F;

 Talares talares = new Talares(cache);
 F.Promise pagePromise = talares.getPage(1, 2);
 

Since:

0.1.0

See Also:

Cache

Constructor Summary

Constructors

Constructor and Description
Talares()
Talares(Cache cache)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.talares.api.Talares	getApi(Cache cache)
Binary	getBinary_(int publicationId, int binaryId) BLOCKING Get a Binary by it's publication ID and binary ID.
Binary	getBinary_(int publicationId, int binaryId, long timeout) BLOCKING Get a Binary by it's publication ID and binary ID.
play.libs.F.Promise<Binary>	getBinary(int publicationId, int binaryId) Get a Binary by it's publication ID and binary ID.
BinaryContent	getBinaryContent_(int publicationId, int binaryId, java.lang.String variantId) BLOCKING Get a BinaryContent by it's publication ID, binary ID and variant ID.
BinaryContent	getBinaryContent_(int publicationId, int binaryId, java.lang.String variantId, long timeout) BLOCKING Get a BinaryContent by it's publication ID and binary ID.
play.libs.F.Promise<BinaryContent>	getBinaryContent(int publicationId, int binaryId, java.lang.String variantId) Get a BinaryContent by it's publication ID, binary ID and variant ID.
BinaryVariant	getBinaryVariant_(int publicationId, int binaryId) BLOCKING Get a BinaryVariant by it's publication ID and binary ID.
BinaryVariant	getBinaryVariant_(int publicationId, int binaryId, long timeout) BLOCKING Get a BinaryVariant by it's publication ID and binary ID.
play.libs.F.Promise<BinaryVariant>	getBinaryVariant(int publicationId, int binaryId) Get a BinaryVariant by it's publication ID and binary ID.
Component	getComponent_(int publicationId, int itemId) BLOCKING Get a Component by it's publication ID and item ID.
Component	getComponent_(int publicationId, int itemId, long timeout) BLOCKING Get a Component by it's publication ID and item ID.
play.libs.F.Promise<Component>	getComponent(int publicationId, int itemId) Get a Component by it's publication ID and item ID.
ComponentPresentation	getComponentPresentation_(int publicationId, int componentId, int templateId) BLOCKING Get a ComponentPresentation by it's publication ID, component ID and templateId ID.
ComponentPresentation	getComponentPresentation_(int publicationId, int componentId, int templateId, long timeout) BLOCKING Get a ComponentPresentation by it's publication ID, component ID and templateId ID.
play.libs.F.Promise<ComponentPresentation>	getComponentPresentation(int publicationId, int componentId, int templateId) Get a ComponentPresentation by it's publication ID, component ID and templateId ID.
CustomMeta	getCustomMeta_(int id) BLOCKING Get a CustomMeta by it's ID.
CustomMeta	getCustomMeta_(int id, long timeout) BLOCKING Get a CustomMeta by it's ID.
play.libs.F.Promise<CustomMeta>	getCustomMeta(int id) Get a CustomMeta by it's ID.
Keyword	getKeyword_(int publicationId, int id, int taxonomyId) BLOCKING Get a Keyword by it's ID, publication ID and taxonomy ID.
Keyword	getKeyword_(int publicationId, int id, int taxonomyId, long timeout) BLOCKING Get a Keyword by it's ID, publication ID and taxonomy ID.
play.libs.F.Promise<Keyword>	getKeyword(int publicationId, int id, int taxonomyId) Get a Keyword by it's ID, publication ID and taxonomy ID.
Page	getPage_(int publicationId, int itemId) BLOCKING Get a Page by it's publication ID and item ID.
Page	getPage_(int publicationId, int itemId, long timeout) BLOCKING Get a Page by it's publication ID and item ID.
java.util.List<Page>	getPage_(java.lang.String url) BLOCKING Get a Page by it's URL.
java.util.List<Page>	getPage_(java.lang.String url, long timeout) BLOCKING Get a Page by it's URL.
play.libs.F.Promise<Page>	getPage(int publicationId, int itemId) Get a Page by it's publication ID and item ID.
play.libs.F.Promise<java.util.List<Page>>	getPage(java.lang.String url) Get a Page by it's URL.
PageContent	getPageContent_(int publicationId, int pageId) BLOCKING Get a PageContent by it's publication ID and page ID.
PageContent	getPageContent_(int publicationId, int pageId, long timeout) BLOCKING Get a PageContent by it's publication ID and page ID.
play.libs.F.Promise<PageContent>	getPageContent(int publicationId, int pageId) Get a PageContent by it's publication ID and page ID.
Publication	getPublication_(int id) BLOCKING Get a Publication by it's ID.
Publication	getPublication_(int id, long timeout) BLOCKING Get a Publication by it's ID.
play.libs.F.Promise<Publication>	getPublication(int id) Get a Publication by it's ID.
Schema	getSchema_(int publicationId, int schemaId) BLOCKING Get a Schema by it's publication ID and schema ID.
Schema	getSchema_(int publicationId, int schemaId, long timeout) BLOCKING Get a Schema by it's publication ID and schema ID.
play.libs.F.Promise<Schema>	getSchema(int publicationId, int schemaId) Get a Schema by it's publication ID and schema ID.
StructureGroup	getStructureGroup_(int publicationId, int id) BLOCKING Get a StructureGroup by it's ID and publication ID.
StructureGroup	getStructureGroup_(int publicationId, int id, long timeout) BLOCKING Get a StructureGroup by it's ID and publication ID.
play.libs.F.Promise<StructureGroup>	getStructureGroup(int publicationId, int id) Get a StructureGroup by it's ID and publication ID.
Template	getTemplate_(int publicationId, int itemId) BLOCKING Get a Template by it's publication ID and item ID.
Template	getTemplate_(int publicationId, int itemId, long timeout) BLOCKING Get a Template by it's publication ID and item ID.
play.libs.F.Promise<Template>	getTemplate(int publicationId, int itemId) Get a Template by it's publication ID and item ID.
void	terminate() Terminates the library which implies shutting down the actor system.

Methods inherited from class java.lang.Object

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

Constructor Detail

Talares

public Talares()

Talares

public Talares(Cache cache)

Method Detail

getApi

protected org.talares.api.Talares getApi(Cache cache)

terminate

public final void terminate()

Terminates the library which implies shutting down the actor system. Should be used when the API will no longer be accesses and only then.

getBinary

public final play.libs.F.Promise<Binary> getBinary(int publicationId,
                                    int binaryId)

Get a Binary by it's publication ID and binary ID.

Parameters:

publicationId - the ID of the publication the desired Binary belongs to

binaryId - the binary ID of the desired Binary

Returns:

a F.Promise of a Binary

getBinary_

public final Binary getBinary_(int publicationId,
                int binaryId,
                long timeout)
                        throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Binary by it's publication ID and binary ID.

Parameters:

publicationId - the ID of the publication the desired Binary belongs to

binaryId - the ID of the desired Binary

timeout - the timeout in milliseconds within which the Binary should be present

Returns:

a Binary

Throws:

org.talares.api.exceptions.TalaresException

getBinary_

public final Binary getBinary_(int publicationId,
                int binaryId)
                        throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Binary by it's publication ID and binary ID.

Parameters:

publicationId - the ID of the publication the desired Binary belongs to

binaryId - the ID of the desired Binary

Returns:

a Binary

Throws:

org.talares.api.exceptions.TalaresException

getBinaryContent

public final play.libs.F.Promise<BinaryContent> getBinaryContent(int publicationId,
                                                  int binaryId,
                                                  java.lang.String variantId)

Get a BinaryContent by it's publication ID, binary ID and variant ID.

Parameters:

publicationId - the ID of the publication the desired BinaryContent belongs to

binaryId - the ID of the desired BinaryContent

variantId - the variant ID of the desired BinaryContent

Returns:

a F.Promise of a BinaryContent

getBinaryContent_

public final BinaryContent getBinaryContent_(int publicationId,
                              int binaryId,
                              java.lang.String variantId,
                              long timeout)
                                      throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a BinaryContent by it's publication ID and binary ID.

Parameters:

publicationId - the ID of the publication the desired BinaryContent belongs to

binaryId - the ID of the desired BinaryContent

variantId - the variant ID of the desired BinaryContent

timeout - the timeout in milliseconds within which the BinaryContent should be present

Returns:

a BinaryContent

Throws:

org.talares.api.exceptions.TalaresException

getBinaryContent_

public final BinaryContent getBinaryContent_(int publicationId,
                              int binaryId,
                              java.lang.String variantId)
                                      throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a BinaryContent by it's publication ID, binary ID and variant ID.

Parameters:

publicationId - the ID of the publication the desired BinaryContent belongs to

binaryId - the ID of the desired BinaryContent

variantId - the variant ID of the desired BinaryContent

Returns:

a BinaryContent

Throws:

org.talares.api.exceptions.TalaresException

getBinaryVariant

public final play.libs.F.Promise<BinaryVariant> getBinaryVariant(int publicationId,
                                                  int binaryId)

Get a BinaryVariant by it's publication ID and binary ID.

Parameters:

publicationId - the ID of the publication the desired BinaryVariant belongs to

binaryId - the ID of the desired BinaryVariant

Returns:

a F.Promise of a BinaryVariant

getBinaryVariant_

public final BinaryVariant getBinaryVariant_(int publicationId,
                              int binaryId,
                              long timeout)
                                      throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a BinaryVariant by it's publication ID and binary ID.

Parameters:

publicationId - the ID of the publication the desired BinaryVariant belongs to

binaryId - the ID of the desired BinaryVariant

timeout - the timeout in milliseconds within which the BinaryVariant should be present

Returns:

a BinaryVariant

Throws:

org.talares.api.exceptions.TalaresException

getBinaryVariant_

public final BinaryVariant getBinaryVariant_(int publicationId,
                              int binaryId)
                                      throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a BinaryVariant by it's publication ID and binary ID.

Parameters:

publicationId - the ID of the publication the desired BinaryVariant belongs to

binaryId - the ID of the desired BinaryVariant

Returns:

a BinaryVariant

Throws:

org.talares.api.exceptions.TalaresException

getComponent

public final play.libs.F.Promise<Component> getComponent(int publicationId,
                                          int itemId)

Get a Component by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Component belongs to

itemId - the item ID of the desired Component

Returns:

a F.Promise of a Component

getComponent_

public final Component getComponent_(int publicationId,
                      int itemId,
                      long timeout)
                              throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Component by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Component belongs to

itemId - the item ID of the desired Component

timeout - the timeout in milliseconds within which the Component should be present

Returns:

a Component

Throws:

org.talares.api.exceptions.TalaresException

getComponent_

public final Component getComponent_(int publicationId,
                      int itemId)
                              throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Component by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Component belongs to

itemId - the item ID of the desired Component

Returns:

a Component

Throws:

org.talares.api.exceptions.TalaresException

getComponentPresentation

public final play.libs.F.Promise<ComponentPresentation> getComponentPresentation(int publicationId,
                                                                  int componentId,
                                                                  int templateId)

Get a ComponentPresentation by it's publication ID, component ID and templateId ID.

Parameters:

publicationId - the ID of the publication the desired ComponentPresentation belongs to

componentId - the component ID of the desired ComponentPresentation

templateId - the template ID of the desired ComponentPresentation

Returns:

a F.Promise of a ComponentPresentation

getComponentPresentation_

public final ComponentPresentation getComponentPresentation_(int publicationId,
                                              int componentId,
                                              int templateId,
                                              long timeout)
                                                      throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a ComponentPresentation by it's publication ID, component ID and templateId ID.

Parameters:

publicationId - the ID of the publication the desired ComponentPresentation belongs to

componentId - the component ID of the desired ComponentPresentation

templateId - the template ID of the desired ComponentPresentation

timeout - the timeout in milliseconds within which the ComponentPresentation should be present

Returns:

a ComponentPresentation

Throws:

org.talares.api.exceptions.TalaresException

getComponentPresentation_

public final ComponentPresentation getComponentPresentation_(int publicationId,
                                              int componentId,
                                              int templateId)
                                                      throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a ComponentPresentation by it's publication ID, component ID and templateId ID.

Parameters:

publicationId - the ID of the publication the desired ComponentPresentation belongs to

componentId - the component ID of the desired ComponentPresentation

templateId - the template ID of the desired ComponentPresentation

Returns:

a ComponentPresentation

Throws:

org.talares.api.exceptions.TalaresException

getCustomMeta

public final play.libs.F.Promise<CustomMeta> getCustomMeta(int id)

Get a CustomMeta by it's ID.

Parameters:

id - the ID of the desired CustomMeta

Returns:

a F.Promise of a CustomMeta

getCustomMeta_

public final CustomMeta getCustomMeta_(int id,
                        long timeout)
                                throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a CustomMeta by it's ID.

Parameters:

id - the ID of the desired CustomMeta

timeout - the timeout in milliseconds within which the CustomMeta should be present

Returns:

a CustomMeta

Throws:

org.talares.api.exceptions.TalaresException

getCustomMeta_

public final CustomMeta getCustomMeta_(int id)
                                throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a CustomMeta by it's ID.

Parameters:

id - the ID of the desired CustomMeta

Returns:

a CustomMeta

Throws:

org.talares.api.exceptions.TalaresException

getKeyword

public final play.libs.F.Promise<Keyword> getKeyword(int publicationId,
                                      int id,
                                      int taxonomyId)

Get a Keyword by it's ID, publication ID and taxonomy ID.

Parameters:

publicationId - the ID of the publication the desired Keyword belongs to

id - the ID of the desired Keyword

taxonomyId - the taxonomy ID of the desired Keyword

Returns:

a F.Promise of a Keyword

getKeyword_

public final Keyword getKeyword_(int publicationId,
                  int id,
                  int taxonomyId,
                  long timeout)
                          throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Keyword by it's ID, publication ID and taxonomy ID.

Parameters:

publicationId - the ID of the publication the desired Keyword belongs to

id - the ID of the desired Keyword

taxonomyId - the taxonomy ID of the desired Keyword

timeout - the timeout in milliseconds within which the Keyword should be present

Returns:

a Keyword

Throws:

org.talares.api.exceptions.TalaresException

getKeyword_

public final Keyword getKeyword_(int publicationId,
                  int id,
                  int taxonomyId)
                          throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Keyword by it's ID, publication ID and taxonomy ID.

Parameters:

publicationId - the ID of the publication the desired Keyword belongs to

id - the ID of the desired Keyword

taxonomyId - the taxonomy ID of the desired Keyword

Returns:

a Keyword

Throws:

org.talares.api.exceptions.TalaresException

getPage

public final play.libs.F.Promise<Page> getPage(int publicationId,
                                int itemId)

Get a Page by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Page belongs to

itemId - the item ID of the desired Page

Returns:

a F.Promise of a Page

getPage_

public final Page getPage_(int publicationId,
            int itemId,
            long timeout)
                    throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Page by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Page belongs to

itemId - the item ID of the desired Page

timeout - the timeout in milliseconds within which the Page should be present

Returns:

a Page

Throws:

org.talares.api.exceptions.TalaresException

getPage_

public final Page getPage_(int publicationId,
            int itemId)
                    throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Page by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Page belongs to

itemId - the item ID of the desired Page

Returns:

a Page

Throws:

org.talares.api.exceptions.TalaresException

getPage

public final play.libs.F.Promise<java.util.List<Page>> getPage(java.lang.String url)

Get a Page by it's URL.

Parameters:

url - the URL of the page within Tridion

Returns:

a F.Promise of a List of Page's

getPage_

public final java.util.List<Page> getPage_(java.lang.String url,
                            long timeout)
                                    throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Page by it's URL.

Parameters:

url - the URL of the page within Tridion

timeout - the timeout in milliseconds within which the Page should be present

Returns:

a Page

Throws:

org.talares.api.exceptions.TalaresException

getPage_

public final java.util.List<Page> getPage_(java.lang.String url)
                                    throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Page by it's URL.

Parameters:

url - the URL of the page within Tridion

Returns:

a Page

Throws:

org.talares.api.exceptions.TalaresException

getPageContent

public final play.libs.F.Promise<PageContent> getPageContent(int publicationId,
                                              int pageId)

Get a PageContent by it's publication ID and page ID.

Parameters:

publicationId - the ID of the publication the desired PageContent belongs to

pageId - the page ID of the desired PageContent

Returns:

a F.Promise of a PageContent

getPageContent_

public final PageContent getPageContent_(int publicationId,
                          int pageId,
                          long timeout)
                                  throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a PageContent by it's publication ID and page ID.

Parameters:

publicationId - the ID of the publication the desired PageContent belongs to

pageId - the page ID of the desired PageContent

timeout - the timeout in milliseconds within which the PageContent should be present

Returns:

a PageContent

Throws:

org.talares.api.exceptions.TalaresException

getPageContent_

public final PageContent getPageContent_(int publicationId,
                          int pageId)
                                  throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a PageContent by it's publication ID and page ID.

Parameters:

publicationId - the ID of the publication the desired PageContent belongs to

pageId - the page ID of the desired PageContent

Returns:

a PageContent

Throws:

org.talares.api.exceptions.TalaresException

getPublication

public final play.libs.F.Promise<Publication> getPublication(int id)

Get a Publication by it's ID.

Parameters:

id - the ID of the desired Publication

Returns:

a F.Promise of a Publication

getPublication_

public final Publication getPublication_(int id,
                          long timeout)
                                  throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Publication by it's ID.

Parameters:

id - the ID of the desired Publication

timeout - the timeout in milliseconds within which the Publication should be present

Returns:

a Publication

Throws:

org.talares.api.exceptions.TalaresException

getPublication_

public final Publication getPublication_(int id)
                                  throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Publication by it's ID.

Parameters:

id - the ID of the desired Publication

Returns:

a Publication

Throws:

org.talares.api.exceptions.TalaresException

getSchema

public final play.libs.F.Promise<Schema> getSchema(int publicationId,
                                    int schemaId)

Get a Schema by it's publication ID and schema ID.

Parameters:

publicationId - the ID of the publication the desired Schema belongs to

schemaId - the schema ID of the desired Schema

Returns:

a F.Promise of a Schema

getSchema_

public final Schema getSchema_(int publicationId,
                int schemaId,
                long timeout)
                        throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Schema by it's publication ID and schema ID.

Parameters:

publicationId - the ID of the publication the desired Schema belongs to

schemaId - the schema ID of the desired Schema

timeout - the timeout in milliseconds within which the Schema should be present

Returns:

a Schema

Throws:

org.talares.api.exceptions.TalaresException

getSchema_

public final Schema getSchema_(int publicationId,
                int schemaId)
                        throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Schema by it's publication ID and schema ID.

Parameters:

publicationId - the ID of the publication the desired Schema belongs to

schemaId - the schema ID of the desired Schema

Returns:

a Schema

Throws:

org.talares.api.exceptions.TalaresException

getStructureGroup

public final play.libs.F.Promise<StructureGroup> getStructureGroup(int publicationId,
                                                    int id)

Get a StructureGroup by it's ID and publication ID.

Parameters:

publicationId - the ID of the publication the desired StructureGroup belongs to

id - the ID of the desired StructureGroup

Returns:

a F.Promise of a StructureGroup

getStructureGroup_

public final StructureGroup getStructureGroup_(int publicationId,
                                int id,
                                long timeout)
                                        throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a StructureGroup by it's ID and publication ID.

Parameters:

publicationId - the ID of the publication the desired StructureGroup belongs to

id - the ID of the desired StructureGroup

timeout - the timeout in milliseconds within which the StructureGroup should be present

Returns:

a StructureGroup

Throws:

org.talares.api.exceptions.TalaresException

getStructureGroup_

public final StructureGroup getStructureGroup_(int publicationId,
                                int id)
                                        throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a StructureGroup by it's ID and publication ID.

Parameters:

publicationId - the ID of the publication the desired StructureGroup belongs to

id - the ID of the desired StructureGroup

Returns:

a StructureGroup

Throws:

org.talares.api.exceptions.TalaresException

getTemplate

public final play.libs.F.Promise<Template> getTemplate(int publicationId,
                                        int itemId)

Get a Template by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Template belongs to

itemId - the item ID of the desired Template

Returns:

a F.Promise of a Template

getTemplate_

public final Template getTemplate_(int publicationId,
                    int itemId,
                    long timeout)
                            throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Template by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Template belongs to

itemId - the item ID of the desired Template

timeout - the timeout in milliseconds within which the Template should be present

Returns:

a Template

Throws:

org.talares.api.exceptions.TalaresException

getTemplate_

public final Template getTemplate_(int publicationId,
                    int itemId)
                            throws org.talares.api.exceptions.TalaresException

BLOCKING

Get a Template by it's publication ID and item ID.

Parameters:

publicationId - the ID of the publication the desired Template belongs to

itemId - the item ID of the desired Template

Returns:

a Template

Throws:

org.talares.api.exceptions.TalaresException