Package com.cloudinary

Class Url

java.lang.Object

com.cloudinary.Url

public class Url
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String[]	DEFAULT_VIDEO_SOURCE_TYPES

Constructor Summary

Constructors

Constructor	Description
Url(Cloudinary cloudinary)

Method Summary

Modifier and Type	Method	Description
Url	authToken(AuthToken authToken)	Set the authorization token.
Url	cdnSubdomain(boolean cdnSubdomain)
Url	clone()
Url	cloudName(java.lang.String cloudName)
Url	cname(java.lang.String cname)
Url	fallbackContent(java.lang.String fallbackContent)
java.lang.String	finalizeResourceType(java.lang.String resourceType, java.lang.String type, java.lang.String urlSuffix, boolean useRootPath, boolean shorten)
Url	forceVersion(boolean forceVersion)	Indicates whether to add '/v1/' to the URL when the public ID includes folders and a 'version' value was not defined.
Url	format(java.lang.String format)
Url	fromIdentifier(java.lang.String identifier)	Parses a cloudinary identifier of the form: [<resource_type>/][<image_type>/][v<version>/]<public_id>[.<format>][#<signature>]
java.lang.String	generate()
java.lang.String	generate(java.lang.String source)
java.lang.String	generateSpriteCss(java.lang.String source)
java.lang.String	imageTag(java.lang.String source)
java.lang.String	imageTag(java.lang.String source, java.util.Map<java.lang.String,java.lang.String> attributes)
java.lang.String	imageTag(java.util.Map<java.lang.String,java.lang.String> attributes)
Url	poster(java.lang.Object poster)
Url	posterSource(java.lang.String posterSource)
Url	posterTransformation(Transformation posterTransformation)
Url	posterTransformation(java.util.List<java.util.Map> posterTransformations)
Url	posterTransformation(java.util.Map posterTransformations)
Url	posterUrl(Url posterUrl)
Url	privateCdn(boolean privateCdn)
Url	publicId(java.lang.Object publicId)
Url	resourceType(java.lang.String resourceType)
Url	resourcType(java.lang.String resourceType)
Url	secure(boolean secure)
Url	secureCdnSubdomain(boolean secureCdnSubdomain)
Url	secureDistribution(java.lang.String secureDistribution)
Url	shorten(boolean shorten)
Url	signed(boolean signUrl)
Url	source(StoredFile source)
Url	source(java.lang.String source)
Url	sourceTransformation(java.util.Map<java.lang.String,Transformation> sourceTransformation)
Url	sourceTransformationFor(java.lang.String source, Transformation transformation)
Url	sourceTypes(java.lang.String[] sourceTypes)
Url	suffix(java.lang.String urlSuffix)
Transformation	transformation()
Url	transformation(Transformation transformation)
Url	type(java.lang.String type)
java.lang.String	unsignedDownloadUrlPrefix(java.lang.String source, java.lang.String cloudName, boolean privateCdn, boolean cdnSubdomain, java.lang.Boolean secureCdnSubdomain, java.lang.String cname, boolean secure, java.lang.String secureDistribution)
Url	useRootPath(boolean useRootPath)
Url	version(java.lang.Object version)
java.lang.String	videoTag()
java.lang.String	videoTag(java.lang.String source)
java.lang.String	videoTag(java.lang.String source, java.util.Map<java.lang.String,java.lang.String> attributes)
java.lang.String	videoTag(java.util.Map<java.lang.String,java.lang.String> attributes)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VIDEO_SOURCE_TYPES

public static final java.lang.String[] DEFAULT_VIDEO_SOURCE_TYPES

Constructor Detail

Url

public Url(Cloudinary cloudinary)

Method Detail

clone

public Url clone()

Overrides:

clone in class java.lang.Object

fromIdentifier

public Url fromIdentifier(java.lang.String identifier)

Parses a cloudinary identifier of the form:
[<resource_type>/][<image_type>/][v<version>/]<public_id>[.<format>][#<signature>]

type

public Url type(java.lang.String type)

resourcType

public Url resourcType(java.lang.String resourceType)

resourceType

public Url resourceType(java.lang.String resourceType)

publicId

public Url publicId(java.lang.Object publicId)

format

public Url format(java.lang.String format)

cloudName

public Url cloudName(java.lang.String cloudName)

secureDistribution

public Url secureDistribution(java.lang.String secureDistribution)

secureCdnSubdomain

public Url secureCdnSubdomain(boolean secureCdnSubdomain)

suffix

public Url suffix(java.lang.String urlSuffix)

useRootPath

public Url useRootPath(boolean useRootPath)

cname

public Url cname(java.lang.String cname)

version

public Url version(java.lang.Object version)

transformation

public Url transformation(Transformation transformation)

secure

public Url secure(boolean secure)

privateCdn

public Url privateCdn(boolean privateCdn)

cdnSubdomain

public Url cdnSubdomain(boolean cdnSubdomain)

shorten

public Url shorten(boolean shorten)

transformation

public Transformation transformation()

signed

public Url signed(boolean signUrl)

authToken

public Url authToken(AuthToken authToken)

Set the authorization token. If authToken has already been set the parameter is merged with the current value unless the parameter value is null or NULL_AUTH_TOKEN.

For example, to generate an authorized URL with a different duration:

  
   cloudinary.config.authToken = new AuthToken(KEY).duration(500);
   // later...
   cloudinary.url().signed(true).authToken(new AuthToken().duration(300))
                   .type("authenticated").version("1486020273").generate("sample.jpg");
  
 

Parameters:

authToken - an authorization token object

Returns:

this

sourceTransformation

public Url sourceTransformation(java.util.Map<java.lang.String,Transformation> sourceTransformation)

sourceTransformationFor

public Url sourceTransformationFor(java.lang.String source,
                                   Transformation transformation)

sourceTypes

public Url sourceTypes(java.lang.String[] sourceTypes)

fallbackContent

public Url fallbackContent(java.lang.String fallbackContent)

posterTransformation

public Url posterTransformation(Transformation posterTransformation)

posterTransformation

public Url posterTransformation(java.util.List<java.util.Map> posterTransformations)

posterTransformation

public Url posterTransformation(java.util.Map posterTransformations)

posterSource

public Url posterSource(java.lang.String posterSource)

posterUrl

public Url posterUrl(Url posterUrl)

poster

public Url poster(java.lang.Object poster)

forceVersion

public Url forceVersion(boolean forceVersion)

Indicates whether to add '/v1/' to the URL when the public ID includes folders and a 'version' value was not defined. When no version is explicitly specified and the public id contains folders, a default v1 version is added to the url. This boolean can disable that behaviour.

Parameters:

forceVersion - Whether to add the version to the url.

Returns:

This same Url instance for chaining.

generate

public java.lang.String generate()

generate

public java.lang.String generate(java.lang.String source)

finalizeResourceType

public java.lang.String finalizeResourceType(java.lang.String resourceType,
                                             java.lang.String type,
                                             java.lang.String urlSuffix,
                                             boolean useRootPath,
                                             boolean shorten)

unsignedDownloadUrlPrefix

public java.lang.String unsignedDownloadUrlPrefix(java.lang.String source,
                                                  java.lang.String cloudName,
                                                  boolean privateCdn,
                                                  boolean cdnSubdomain,
                                                  java.lang.Boolean secureCdnSubdomain,
                                                  java.lang.String cname,
                                                  boolean secure,
                                                  java.lang.String secureDistribution)

imageTag

public java.lang.String imageTag(java.lang.String source)

imageTag

public java.lang.String imageTag(java.util.Map<java.lang.String,java.lang.String> attributes)

imageTag

public java.lang.String imageTag(java.lang.String source,
                                 java.util.Map<java.lang.String,java.lang.String> attributes)

videoTag

public java.lang.String videoTag()

videoTag

public java.lang.String videoTag(java.lang.String source)

videoTag

public java.lang.String videoTag(java.util.Map<java.lang.String,java.lang.String> attributes)

videoTag

public java.lang.String videoTag(java.lang.String source,
                                 java.util.Map<java.lang.String,java.lang.String> attributes)

generateSpriteCss

public java.lang.String generateSpriteCss(java.lang.String source)

source

public Url source(java.lang.String source)

source

public Url source(StoredFile source)