Package org.craftercms.studio.impl.v1.service.box

Class BoxServiceImpl

java.lang.Object

org.craftercms.studio.impl.v1.service.box.BoxServiceImpl

All Implemented Interfaces:

BoxService

public class BoxServiceImpl
extends Object
implements BoxService

Field Summary

Fields

Modifier and Type	Field	Description
protected SiteAwareConfigProfileLoader<org.craftercms.commons.config.profiles.box.BoxProfile>	profileLoader
protected static final String	URL_FORMAT

Constructor Summary

Constructors

Constructor	Description
BoxServiceImpl(SiteAwareConfigProfileLoader<org.craftercms.commons.config.profiles.box.BoxProfile> profileLoader)

Method Summary

Modifier and Type	Method	Description
String	getAccessToken(String site, String profileId)	Gets an access token to allow direct access to the Box folder.
protected com.box.sdk.BoxAPIConnection	getConnection(org.craftercms.commons.config.profiles.box.BoxProfile profile)
protected org.craftercms.commons.config.profiles.box.BoxProfile	getProfile(String site, String profileId)
String	getUrl(String site, String profileId, String fileId, String filename)	Builds a local URL for the given asset

Methods inherited from class java.lang.Object

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

Field Details

URL_FORMAT

protected static final String URL_FORMAT

See Also:

• Constant Field Values

profileLoader

protected SiteAwareConfigProfileLoader<org.craftercms.commons.config.profiles.box.BoxProfile> profileLoader

Constructor Details

BoxServiceImpl

public BoxServiceImpl(SiteAwareConfigProfileLoader<org.craftercms.commons.config.profiles.box.BoxProfile> profileLoader)

Method Details

getProfile

protected org.craftercms.commons.config.profiles.box.BoxProfile getProfile(String site,
 String profileId)
                                                                    throws BoxException,
org.craftercms.commons.config.profiles.ConfigurationProfileNotFoundException

Throws:

BoxException

org.craftercms.commons.config.profiles.ConfigurationProfileNotFoundException

getConnection

protected com.box.sdk.BoxAPIConnection getConnection(org.craftercms.commons.config.profiles.box.BoxProfile profile)

getAccessToken

public String getAccessToken(String site,
 String profileId)
                      throws BoxException,
org.craftercms.commons.config.profiles.ConfigurationProfileNotFoundException

Gets an access token to allow direct access to the Box folder.

Specified by:

getAccessToken in interface BoxService

Parameters:

site - the name of the site to search for the configuration file

profileId - the name of the profile to search

Returns:

the value of the access token

Throws:

BoxException - box error

org.craftercms.commons.config.profiles.ConfigurationProfileNotFoundException - if the profile is not found

getUrl

public String getUrl(String site,
 String profileId,
 String fileId,
 String filename)
              throws BoxException,
org.craftercms.commons.config.profiles.ConfigurationProfileNotFoundException

Builds a local URL for the given asset

Specified by:

getUrl in interface BoxService

Parameters:

site - site identifier

profileId - the name of the profile to use

fileId - the id of the file

filename - the name of the file

Returns:

the local URL for the file

Throws:

BoxException - box error

org.craftercms.commons.config.profiles.ConfigurationProfileNotFoundException - if the profile is not found