com.toopher.ToopherAPI クラス

com.toopher.ToopherAPI 連携図

公開メンバ関数
	ToopherAPI (String consumerKey, String consumerSecret)
PairingStatus	pair (String pairingPhrase, String userName) throws RequestError
PairingStatus	getPairingStatus (String pairingRequestId) throws RequestError
AuthenticationStatus	authenticate (String pairingId, String terminalName) throws RequestError
AuthenticationStatus	authenticate (String pairingId, String terminalName, String actionName) throws RequestError
AuthenticationStatus	getAuthenticationStatus (String authenticationRequestId) throws RequestError

静的公開変数類
static final String	VERSION = "1.0.0"

非公開メンバ関数
JSONObject	get (String endpoint) throws Exception
JSONObject	post (String endpoint, List< NameValuePair > params) throws Exception

非公開変数類
final HttpClient	httpClient
final OAuthConsumer	consumer

静的非公開変数類
static ResponseHandler< JSONObject >	jsonHandler
static final String	URI_SCHEME = "https"
static final String	URI_HOST = "api.toopher.com"
static final String	URI_BASE = "/v1/"

詳解

A Java binding for the Toopher API

構築子と解体子

ToopherAPI()

com.toopher.ToopherAPI.ToopherAPI ( String  consumerKey, String  consumerSecret  )

inline

Create an API object with the supplied credentials

引数

consumerKey	The consumer key for a requester (obtained from the developer portal)
consumerSecret	The consumer secret for a requester (obtained from the developer portal)

                                                                 {
        httpClient = new DefaultHttpClient();
        HttpProtocolParams.setUserAgent(httpClient.getParams(),
                                        String.format("ToopherJava/%s", VERSION));

        consumer = new CommonsHttpOAuthConsumer(consumerKey, consumerSecret);
    }

関数詳解

authenticate() [1/2]

AuthenticationStatus com.toopher.ToopherAPI.authenticate ( String  pairingId, String  terminalName  ) throws RequestError

inline

Initiate a login authentication request

引数

pairingId	The pairing id indicating to whom the request should be sent
terminalName	The user-facing descriptive name for the terminal from which the request originates

戻り値

An AuthenticationStatus object

例外

RequestError

Thrown when an exceptional condition is encountered

                                                                                                        {
        return authenticate(pairingId, terminalName, null);
    }

authenticate() [2/2]

AuthenticationStatus com.toopher.ToopherAPI.authenticate ( String  pairingId, String  terminalName, String  actionName  ) throws RequestError

inline

Initiate an authentication request

引数

pairingId	The pairing id indicating to whom the request should be sent
terminalName	The user-facing descriptive name for the terminal from which the request originates
actionName	The user-facing descriptive name for the action which is being authenticated

戻り値

An AuthenticationStatus object

例外

RequestError

Thrown when an exceptional condition is encountered

                                                                                    {
        final String endpoint = "authentication_requests/initiate";

        List<NameValuePair> params = new ArrayList<NameValuePair>();
        params.add(new BasicNameValuePair("pairing_id", pairingId));
        params.add(new BasicNameValuePair("terminal_name", terminalName));
        if (actionName != null && actionName.length() > 0) {
            params.add(new BasicNameValuePair("action_name", actionName));
        }

        try {
            JSONObject json = post(endpoint, params);
            return AuthenticationStatus.fromJSON(json);
        } catch (Exception e) {
            throw new RequestError(e);
        }
    }

get()

JSONObject com.toopher.ToopherAPI.get ( String  endpoint ) throws Exception

inlineprivate

                                                             {
        URI uri = new URIBuilder().setScheme(URI_SCHEME).setHost(URI_HOST)
                                  .setPath(URI_BASE + endpoint).build();
        HttpGet get = new HttpGet(uri);
        consumer.sign(get);
        return httpClient.execute(get, jsonHandler);
    }

getAuthenticationStatus()

AuthenticationStatus com.toopher.ToopherAPI.getAuthenticationStatus ( String  authenticationRequestId ) throws RequestError

inline

Retrieve status information for an authentication request

引数

authenticationRequestId

The authentication request ID

戻り値

An AuthenticationStatus object

例外

RequestError

Thrown when an exceptional condition is encountered

                                {
        final String endpoint = String.format("authentication_requests/%s", authenticationRequestId);

        try {
            JSONObject json = get(endpoint);
            return AuthenticationStatus.fromJSON(json);
        } catch (Exception e) {
            throw new RequestError(e);
        }
    }

getPairingStatus()

PairingStatus com.toopher.ToopherAPI.getPairingStatus ( String  pairingRequestId ) throws RequestError

inline

Retrieve the current status of a pairing request

引数

pairingRequestId

The unique id for a pairing request

戻り値

A PairingStatus object

例外

RequestError

Thrown when an exceptional condition is encountered

                                                                                       {
        final String endpoint = String.format("pairings/%s", pairingRequestId);

        try {
            JSONObject json = get(endpoint);
            return PairingStatus.fromJSON(json);
        } catch (Exception e) {
            throw new RequestError(e);
        }
    }

pair()

PairingStatus com.toopher.ToopherAPI.pair ( String  pairingPhrase, String  userName  ) throws RequestError

inline

Create a pairing

引数

pairingPhrase	The pairing phrase supplied by the user
userName	A user-facing descriptive name for the user (displayed in requests)

戻り値

A PairingStatus object

例外

RequestError

Thrown when an exceptional condition is encountered

                                                                                         {
        final String endpoint = "pairings/create";

        List<NameValuePair> params = new ArrayList<NameValuePair>();
        params.add(new BasicNameValuePair("pairing_phrase", pairingPhrase));
        params.add(new BasicNameValuePair("user_name", userName));

        try {
            JSONObject json = post(endpoint, params);
            return PairingStatus.fromJSON(json);
        } catch (Exception e) {
            throw new RequestError(e);
        }
    }

post()

JSONObject com.toopher.ToopherAPI.post ( String  endpoint, List< NameValuePair >  params  ) throws Exception

inlineprivate

                                                                                          {
        URI uri = new URIBuilder().setScheme(URI_SCHEME).setHost(URI_HOST)
                                  .setPath(URI_BASE + endpoint).build();
        HttpPost post = new HttpPost(uri);
        if (params != null && params.size() > 0) {
            post.setEntity(new UrlEncodedFormEntity(params));
        }

        consumer.sign(post);

        return httpClient.execute(post, jsonHandler);
    }

メンバ詳解

consumer

final OAuthConsumer com.toopher.ToopherAPI.consumer

private

httpClient

final HttpClient com.toopher.ToopherAPI.httpClient

private

jsonHandler

ResponseHandler<JSONObject> com.toopher.ToopherAPI.jsonHandler

staticprivate

初期値:

= new ResponseHandler<JSONObject>() {

        @Override
        public JSONObject handleResponse(HttpResponse response) throws ClientProtocolException,
                IOException {
            StatusLine statusLine = response.getStatusLine();
            if (statusLine.getStatusCode() >= 300) {
                throw new HttpResponseException(statusLine.getStatusCode(),
                                                statusLine.getReasonPhrase());
            }

            HttpEntity entity = response.getEntity(); 
            String json = EntityUtils.toString(entity);

            try {
                return (JSONObject) new JSONTokener(json).nextValue();
            } catch (JSONException e) {
                throw new ClientProtocolException("Could not interpret response as JSON", e);
            }
        }
    }

URI_BASE

final String com.toopher.ToopherAPI.URI_BASE = "/v1/"

staticprivate

URI_HOST

final String com.toopher.ToopherAPI.URI_HOST = "api.toopher.com"

staticprivate

URI_SCHEME

final String com.toopher.ToopherAPI.URI_SCHEME = "https"

staticprivate

VERSION

final String com.toopher.ToopherAPI.VERSION = "1.0.0"

static

The ToopherJava binding library version

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/oxAuth/Server/integrations.deprecatred/toopher/sdk/src/main/java/com/toopher/ToopherAPI.java