com.box.boxjavalibv2.resourcemanagers

Class BoxWebLinksManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxItemsManagerImpl

com.box.boxjavalibv2.resourcemanagers.BoxWebLinksManagerImpl

All Implemented Interfaces:

IBoxItemsManager, IBoxResourceManager, IBoxWebLinksManager

public class BoxWebLinksManagerImpl
extends BoxItemsManagerImpl
implements IBoxWebLinksManager

Constructor Summary

Constructors

Constructor and Description
BoxWebLinksManagerImpl(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxWebLink	copyWebLink(java.lang.String webLinkId, BoxItemCopyRequestObject requestObject) Copy a web link.
BoxWebLink	createSharedLink(java.lang.String webLinkId, BoxSharedLinkRequestObject requestObject) Create a shared link for a web link, given the id of the web link.
void	deleteWebLink(java.lang.String webLinkId, BoxDefaultRequestObject requestObject) Delete a web link.
BoxWebLink	getWebLink(java.lang.String webLinkId, BoxDefaultRequestObject requestObject) Get web link given a web link id.
BoxWebLink	updateWebLinkInfo(java.lang.String webLinkId, BoxWebLinkRequestObject requestObject) Update info for a web link.

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.BoxItemsManagerImpl

copyItem, createSharedLink, getItem, updateItemInfo

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObject

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxWebLinksManagerImpl

public BoxWebLinksManagerImpl(IBoxConfig config,
                      IBoxResourceHub resourceHub,
                      IBoxJSONParser parser,
                      IBoxRequestAuth auth,
                      IBoxRESTClient restClient)

Constructor.

Parameters:

config - BoxConfig

resourceHub - resource hub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

getWebLink

public BoxWebLink getWebLink(java.lang.String webLinkId,
                    BoxDefaultRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Description copied from interface: IBoxWebLinksManager

Get web link given a web link id.

Specified by:

getWebLink in interface IBoxWebLinksManager

Parameters:

webLinkId - id of the web link

requestObject - object that goes into request.

Returns:

requested box web link

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

deleteWebLink

public void deleteWebLink(java.lang.String webLinkId,
                 BoxDefaultRequestObject requestObject)
                   throws BoxRestException,
                          BoxServerException,
                          AuthFatalFailureException

Description copied from interface: IBoxWebLinksManager

Delete a web link.

Specified by:

deleteWebLink in interface IBoxWebLinksManager

Parameters:

webLinkId - id of the web link

requestObject - object that goes into request.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

copyWebLink

public BoxWebLink copyWebLink(java.lang.String webLinkId,
                     BoxItemCopyRequestObject requestObject)
                       throws BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Description copied from interface: IBoxWebLinksManager

Copy a web link.

Specified by:

copyWebLink in interface IBoxWebLinksManager

Parameters:

webLinkId - id of the web link

requestObject - request object

Returns:

copied web link

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

updateWebLinkInfo

public BoxWebLink updateWebLinkInfo(java.lang.String webLinkId,
                           BoxWebLinkRequestObject requestObject)
                             throws java.io.UnsupportedEncodingException,
                                    BoxRestException,
                                    BoxServerException,
                                    AuthFatalFailureException

Description copied from interface: IBoxWebLinksManager

Update info for a web link.

Specified by:

updateWebLinkInfo in interface IBoxWebLinksManager

Parameters:

webLinkId - id of the web link

requestObject - request object

Returns:

updated web link

Throws:

java.io.UnsupportedEncodingException - exception

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

createSharedLink

public BoxWebLink createSharedLink(java.lang.String webLinkId,
                          BoxSharedLinkRequestObject requestObject)
                            throws BoxRestException,
                                   BoxServerException,
                                   AuthFatalFailureException

Description copied from interface: IBoxWebLinksManager

Create a shared link for a web link, given the id of the web link.

Specified by:

createSharedLink in interface IBoxWebLinksManager

Parameters:

webLinkId - id of the web link

requestObject - request object

Returns:

the web link, with shared link related fields filled in.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.