com.sdl.web.api.meta

Interface WebBinaryMetaFactory

public interface WebBinaryMetaFactory

The BinaryMetaFactory class loads Binary metadata from the Broker based on the specified tcm:uri of a binary.

//create a new BinaryMetaFactory instance: BinaryMetaFactory binaryMetaFactory = new BinaryMetaFactory(); //find the metadata for the specified binary BinaryMeta binaryMeta = binaryMetaFactory.getMeta("tcm:1-123"); //print the path to the output stream: if(binaryMeta!=null) { out.println("Path of the binary: " + binaryMeta.getURLPath()); }

Method Summary

Modifier and Type	Method and Description
String[]	findAllReferencingPages(String binaryURI) Finds all referencing pages for the specified Binary URI.
String[]	findAllReferencingPages(String binaryURI, String variantId) Finds all referencing pages for the specified Binary URI and its variantId.
com.tridion.meta.BinaryMeta	getMeta(String binaryURI) Finds the Binary metadata for the specified URI.
com.tridion.meta.BinaryMeta	getMeta(String binaryURI, String variantId) Finds the Binary metadata for the specified URI.
com.tridion.meta.BinaryMeta	getMetaByURL(int publicationId, String urlPath) Returns the BinaryMeta object in the Publication identified by the publicationId parameter which has the URL Path as passed by the urlPath parameter.
Collection<com.tridion.meta.BinaryMeta>	getMetaByURL(String urlPath) Returns all BinaryMeta objects which exactly match the URL Path passed as the urlPath parameter.
com.tridion.meta.BinaryMeta	getMetaByURL(String publicationURI, String urlPath) Returns the BinaryMeta object in the Publication identified by the publicationURI parameter which has the URL Path as passed by the urlPath parameter.
com.tridion.meta.BinaryMeta[]	getMetas(String binaryURI) Finds the Binary metadata for the specified URI and all of its variants as a collection.
com.tridion.meta.BinaryMeta[]	getVariants(int publicationId, String variantId) Returns all BinaryMeta objects for the given publication that have the share the given variantId.
com.tridion.meta.BinaryMeta[]	getVariants(String publicationURI, String variantId) Returns all BinaryMeta objects for the given publication that have the share the given variantId.

Method Detail

findAllReferencingPages

String[] findAllReferencingPages(String binaryURI)
                          throws com.tridion.broker.StorageException

Finds all referencing pages for the specified Binary URI. If no references are found for the specified URI, null is returned.

Parameters:

binaryURI - A tcm:URI indicating the binary for which all referencing pages should be retrieved

Returns:

An array of tcm:URI containing all pages that have a reference to the binary URI, or null if no referencing pages were found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

findAllReferencingPages

String[] findAllReferencingPages(String binaryURI,
                                 String variantId)
                          throws com.tridion.broker.StorageException

Finds all referencing pages for the specified Binary URI and its variantId. If no references are found for the specified Binary URI and its variantId, null is returned

Parameters:

binaryURI - A tcm:URI indicating the binary for which all referencing pages should be retrieved

variantId - The variant of the Binary URI to retrieve referencing pages for.

Returns:

An array of tcm:URI containing all pages that have a reference to the binary URI, or null if no referencing pages were found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getMeta

com.tridion.meta.BinaryMeta getMeta(String binaryURI)

Finds the Binary metadata for the specified URI. If the specified Binary is not found, null is returned.

Parameters:

binaryURI - A tcm:uri indicating the binary for which the metadata should be retrieved.

Returns:

A BinaryMeta instance if the specified binary item is found, or null if it is unavailable.

getMeta

com.tridion.meta.BinaryMeta getMeta(String binaryURI,
                                    String variantId)

Finds the Binary metadata for the specified URI. If the specified Binary is not found, null is returned.

Parameters:

binaryURI - A tcm:uri indicating the binary for which the metadata should be retrieved.

variantId - Id of the variant to be returned, may be null or empty

Returns:

A BinaryMeta instance if the specified binary item is found, or null if it is unavailable.

getMetas

com.tridion.meta.BinaryMeta[] getMetas(String binaryURI)

Finds the Binary metadata for the specified URI and all of its variants as a collection.

Parameters:

binaryURI - A tcm:uri indicating the binary for which the metadata should be retrieved.

Returns:

A collection containing BinaryMeta instances if the specified binary item is found, or an empty collection.

getVariants

com.tridion.meta.BinaryMeta[] getVariants(int publicationId,
                                          String variantId)

Returns all BinaryMeta objects for the given publication that have the share the given variantId.

Parameters:

publicationId - The Id of the Publication you want to search in.

variantId - The variant id

Returns:

A Collection containing all BinaryMeta objects that match. If no results are found, an empty Collection is returned.

getVariants

com.tridion.meta.BinaryMeta[] getVariants(String publicationURI,
                                          String variantId)

Returns all BinaryMeta objects for the given publication that have the share the given variantId.

Parameters:

publicationURI - A string representing the TCM URI value of the Publication you want to search in.

variantId - The variant id

Returns:

A Collection containing all BinaryMeta objects that match. If no results are found, an empty Collection is returned.

getMetaByURL

Collection<com.tridion.meta.BinaryMeta> getMetaByURL(String urlPath)

Returns all BinaryMeta objects which exactly match the URL Path passed as the urlPath parameter.

Parameters:

urlPath - The URL Path of the Binary as it is stored in the Binary Metadata.

Returns:

A Collection containing all BinaryMeta objects with the URLPath used to perform the query. In theory, this is one BinaryMeta per Publication. If no results are found, an empty Collection is returned.

getMetaByURL

com.tridion.meta.BinaryMeta getMetaByURL(int publicationId,
                                         String urlPath)

Returns the BinaryMeta object in the Publication identified by the publicationId parameter which has the URL Path as passed by the urlPath parameter.

Parameters:

publicationId - The Id of the Publication you want to search in.

urlPath - The URL Path of the Binary as it is stored in the Binary Metadata.

Returns:

The BinaryMeta object with the URLPath used to perform the query in the Publication identified by publicationId. If no BinaryMeta matches the query, returns null;

getMetaByURL

com.tridion.meta.BinaryMeta getMetaByURL(String publicationURI,
                                         String urlPath)

Returns the BinaryMeta object in the Publication identified by the publicationURI parameter which has the URL Path as passed by the urlPath parameter.

Parameters:

publicationURI - The TCM URI of the Publication you want to search in.

urlPath - The URL Path of the Binary as it is stored in the Binary Metadata.

Returns:

The BinaryMeta object with the URLPath used to perform the query in the Publication identified by publicationId. If no BinaryMeta matches the query, returns null;