com.opsmatters.bitly.api.services.v4

Class BitlinkService

java.lang.Object

com.opsmatters.bitly.api.services.BitlyService

com.opsmatters.bitly.api.services.v4.BitlyV4Service

com.opsmatters.bitly.api.services.v4.BitlinkService

public class BitlinkService
extends BitlyV4Service

The set of operations used for bitlinks.

Author:

Gerald Curley (opsmatters)

Field Summary

Fields inherited from class com.opsmatters.bitly.api.services.v4.BitlyV4Service

CREATE_BITLINK, CREATE_CAMPAIGN, CREATE_CHANNEL, CREATE_CUSTOM_BITLINK, CREATE_WEBHOOK, EXPAND_BITLINK, GET_BITLINK, GET_BITLINK_CLICKS, GET_BITLINK_CLICKS_SUMMARY, GET_BITLINK_QR_CODE, GET_BITLINKS_BY_GROUP, GET_CAMPAIGN, GET_CHANNEL, GET_CUSTOM_BITLINK, GET_GROUP, GET_GROUP_PREFERENCES, GET_GROUP_TAGS, GET_METRICS_BY_COUNTRIES, GET_METRICS_BY_DESTINATION, GET_METRICS_BY_REFERRERS, GET_METRICS_BY_REFERRERS_BY_DOMAIN, GET_METRICS_BY_REFERRING_DOMAINS, GET_METRICS_BY_REFERRING_NETWORKS, GET_OAUTH_APP, GET_ORGANIZATION, GET_SHORTEN_COUNTS, GET_SORTED_BITLINKS_BY_GROUP, GET_USER, GET_WEBHOOK, LIST_BSDS, LIST_CAMPAIGNS, LIST_CHANNELS, LIST_GROUPS, LIST_ORGANIZATIONS, LIST_WEBHOOKS, UPDATE_BITLINK, UPDATE_CAMPAIGN, UPDATE_CHANNEL, UPDATE_CUSTOM_BITLINK, UPDATE_GROUP, UPDATE_GROUP_PREFERENCES, UPDATE_USER, UPDATE_WEBHOOK

Fields inherited from class com.opsmatters.bitly.api.services.BitlyService

HTTP

Constructor Summary

Constructors

Constructor and Description
BitlinkService(String accessToken, HttpContext httpContext) Constructor that takes a http context and API client.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<CreateBitlinkResponse>	create(CreateFullBitlinkRequest request) Creates a bitlink.
com.google.common.base.Optional<ExpandBitlinkResponse>	expand(ExpandBitlinkRequest request) Returns the long url for the given bitlink.
com.google.common.base.Optional<ExpandBitlinkResponse>	expand(String bitlink) Returns the long url for the given bitlink.
com.google.common.base.Optional<GetBitlinkResponse>	get(String bitlink) Returns the attributes of the given bitlink.
com.google.common.base.Optional<GetBitlinkClicksResponse>	getClicks(String bitlink, UnitQuery query) Returns the clicks for the given bitlink.
com.google.common.base.Optional<GetBitlinkClicksSummaryResponse>	getClicksSummary(String bitlink, UnitQuery query) Returns the clicks summary for the given bitlink.
com.google.common.base.Optional<GetMetricsByCountriesResponse>	getMetricsByCountries(String bitlink, UnitQuery query) Returns the metrics for the given bitlink by countries.
com.google.common.base.Optional<GetMetricsByReferrersResponse>	getMetricsByReferrers(String bitlink, UnitQuery query) Returns the metrics for the given bitlink by referrers.
com.google.common.base.Optional<GetMetricsByReferrersByDomainResponse>	getMetricsByReferrersByDomain(String bitlink, UnitQuery query) Returns the metrics for the given bitlink by referrers by domain.
com.google.common.base.Optional<GetMetricsByReferringDomainsResponse>	getMetricsByReferringDomains(String bitlink, UnitQuery query) Returns the metrics for the given bitlink by referring domains.
com.google.common.base.Optional<GetBitlinkQrCodeResponse>	getQrCode(String bitlink) Returns the QR code for the given bitlin.
com.google.common.base.Optional<CreateBitlinkResponse>	shorten(CreateBitlinkRequest request) Shortens the given long url.
com.google.common.base.Optional<CreateBitlinkResponse>	shorten(String longUrl) Shortens the given long url.
com.google.common.base.Optional<UpdateBitlinkResponse>	update(String bitlink, UpdateBitlinkRequest request) Updates the given bitlink.

Methods inherited from class com.opsmatters.bitly.api.services.v4.BitlyV4Service

getQueryParameterList, getQueryParameterList

Methods inherited from class com.opsmatters.bitly.api.services.BitlyService

encode, getHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

BitlinkService

public BitlinkService(String accessToken,
                      HttpContext httpContext)

Constructor that takes a http context and API client.

Parameters:

accessToken - The access token used to authenticate the operations

httpContext - The set of HTTP operations

Method Detail

get

public com.google.common.base.Optional<GetBitlinkResponse> get(String bitlink)
                                                        throws IOException,
                                                               URISyntaxException

Returns the attributes of the given bitlink.

Parameters:

bitlink - The bitlink to be retrieved

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

create

public com.google.common.base.Optional<CreateBitlinkResponse> create(CreateFullBitlinkRequest request)
                                                              throws IOException

Creates a bitlink.

Parameters:

request - The request containing the attributes of the bitlink to be created

Returns:

The response object

Throws:

IOException - if there is a communication error.

shorten

public com.google.common.base.Optional<CreateBitlinkResponse> shorten(String longUrl)
                                                               throws IOException

Shortens the given long url.

Parameters:

longUrl - The long url to be shortened

Returns:

The response object

Throws:

IOException - if there is a communication error.

shorten

public com.google.common.base.Optional<CreateBitlinkResponse> shorten(CreateBitlinkRequest request)
                                                               throws IOException

Shortens the given long url.

Parameters:

request - The request containing the long url to be shortened

Returns:

The response object

Throws:

IOException - if there is a communication error.

expand

public com.google.common.base.Optional<ExpandBitlinkResponse> expand(String bitlink)
                                                              throws IOException

Returns the long url for the given bitlink.

Parameters:

bitlink - The bitlink to be expanded

Returns:

The response object

Throws:

IOException - if there is a communication error.

expand

public com.google.common.base.Optional<ExpandBitlinkResponse> expand(ExpandBitlinkRequest request)
                                                              throws IOException

Returns the long url for the given bitlink.

Parameters:

request - The request containing the bitlink to be expanded

Returns:

The response object

Throws:

IOException - if there is a communication error.

update

public com.google.common.base.Optional<UpdateBitlinkResponse> update(String bitlink,
                                                                     UpdateBitlinkRequest request)
                                                              throws IOException,
                                                                     URISyntaxException

Updates the given bitlink.

Parameters:

bitlink - The bitlink to be updated

request - The request containing the attributes of the bitlink to be updated

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

getClicks

public com.google.common.base.Optional<GetBitlinkClicksResponse> getClicks(String bitlink,
                                                                           UnitQuery query)
                                                                    throws IOException,
                                                                           URISyntaxException

Returns the clicks for the given bitlink.

Parameters:

bitlink - The bitlink for the metrics

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

getClicksSummary

public com.google.common.base.Optional<GetBitlinkClicksSummaryResponse> getClicksSummary(String bitlink,
                                                                                         UnitQuery query)
                                                                                  throws IOException,
                                                                                         URISyntaxException

Returns the clicks summary for the given bitlink.

Parameters:

bitlink - The bitlink for the metrics

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

getMetricsByCountries

public com.google.common.base.Optional<GetMetricsByCountriesResponse> getMetricsByCountries(String bitlink,
                                                                                            UnitQuery query)
                                                                                     throws IOException,
                                                                                            URISyntaxException

Returns the metrics for the given bitlink by countries.

Parameters:

bitlink - The bitlink for the metrics

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

getMetricsByReferrers

public com.google.common.base.Optional<GetMetricsByReferrersResponse> getMetricsByReferrers(String bitlink,
                                                                                            UnitQuery query)
                                                                                     throws IOException,
                                                                                            URISyntaxException

Returns the metrics for the given bitlink by referrers.

Parameters:

bitlink - The bitlink for the metrics

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

getMetricsByReferringDomains

public com.google.common.base.Optional<GetMetricsByReferringDomainsResponse> getMetricsByReferringDomains(String bitlink,
                                                                                                          UnitQuery query)
                                                                                                   throws IOException,
                                                                                                          URISyntaxException

Returns the metrics for the given bitlink by referring domains.

Parameters:

bitlink - The bitlink for the metrics

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

getMetricsByReferrersByDomain

public com.google.common.base.Optional<GetMetricsByReferrersByDomainResponse> getMetricsByReferrersByDomain(String bitlink,
                                                                                                            UnitQuery query)
                                                                                                     throws IOException,
                                                                                                            URISyntaxException

Returns the metrics for the given bitlink by referrers by domain.

Parameters:

bitlink - The bitlink for the metrics

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

getQrCode

public com.google.common.base.Optional<GetBitlinkQrCodeResponse> getQrCode(String bitlink)
                                                                    throws IOException,
                                                                           URISyntaxException

Returns the QR code for the given bitlin.

Parameters:

bitlink - The bitlink for the QR code

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.