OAuth1 Chilkat2 Java Reference Documentation

OAuth1

Current Version: 11.7.0

Markdown version of this page for AI tools (v 11.7.0) · all AI docs

Chilkat.OAuth1

Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.

Chilkat.OAuth1 builds the signed OAuth 1.0 authentication data needed for APIs that still require OAuth 1.0 request signing. It can generate the signature base string, HMAC key, signature, URL-encoded signature, normalized signed parameter string, Authorization header, and generated URL containing OAuth query parameters. It supports consumer credentials, access tokens, nonce and timestamp generation, extra signed parameters, optional realm handling, HMAC-SHA1, HMAC-SHA256, RSA-SHA1, and RSA-SHA256 signing.

OAuth 1.0 signing

Generate the OAuth 1.0 signature and related authentication values from the HTTP method, request URL, credentials, token, nonce, and timestamp.

Authorization header

Produce the value to send in the HTTP Authorization header when OAuth parameters should be supplied as a header.

Signed URL output

Generate a URL that includes the OAuth 1.0 query parameters when the API expects authentication data in the request URL.

Extra signed parameters

Add or remove request-specific name/value parameters that must be included in the normalized parameter string and signature calculation.

HMAC or RSA signatures

Sign with HMAC-SHA1, HMAC-SHA256, RSA-SHA1, or RSA-SHA256, with RSA private keys supplied by SetRsaKey.

Debuggable signing details

Inspect the exact BaseString, HmacKey, QueryString, Signature, and EncodedSignature used to build the OAuth request.

Common pattern: Set OauthMethod and OauthUrl, provide the consumer key and secret, set any token and token secret, generate or assign Nonce and Timestamp, add request parameters with AddParam, then call Generate. Use AuthorizationHeader when sending OAuth data in an HTTP header, or GeneratedUrl when the signed OAuth parameters should be placed in the URL.

URL guidance: Set OauthUrl to the base request URL without query parameters. Add query parameters separately with AddParam so they are included correctly in the OAuth 1.0 signature calculation.

Object Creation

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.OAuth1;

try (OAuth1 oAuth1 = new OAuth1()) {
    // ... use oAuth1 ...
} catch (ChilkatException e) {
    System.out.println(e.getMessage());          // "OAuth1.someMethod failed: <reason>"
    System.out.println(e.getLastErrorText());    // the full log of the failed call
}

public OAuth1()

Creates the underlying native Chilkat object. The native library (chilkat2java) is loaded the first time any Chilkat2 object is created; see the README in the download for where it is looked for (-Dchilkat2.library.path, a classpath resource, or java.library.path).

public void close()

Releases the native object (OAuth1 is AutoCloseable, so try-with-resources calls it). Calling it again does nothing; any other method or property accessor called afterwards throws IllegalStateException. An object that is never closed is freed by a background cleaner once it becomes unreachable, but the garbage collector does not see native memory, so closing is the normal path. Objects returned by methods are owned by the caller too.

public boolean isClosed()

Returns true once close() has been called.

Errors

A method that fails throws ChilkatException, an unchecked exception carrying getClassName(), getMethodName(), getReason() (one line, also in the message) and getLastErrorText() (the full log, captured at the moment of the failure). The object remains usable. Methods that look something up and find nothing return null instead of throwing (each such method says so), and methods that answer a question (hasMember, isUnlocked, ...) return a plain boolean. Property accessors do not throw for Chilkat reasons.

A null string or object argument throws NullPointerException naming the parameter (except where a method documents that null is accepted), and a string containing U+0000 throws IllegalArgumentException.

Use an object from one thread at a time; it may be handed from one thread to another. The one cross-thread operation is setting setAbortCurrent(true) on an object that is busy in another thread (on the classes that have AbortCurrent). Unlocking: call new Global().unlockBundle("...") once at startup.

Properties

AuthorizationHeader

// read-only
String getAuthorizationHeader()

Introduced in version 9.5.0.53

The authorization header. This is what would be included in the Authorization HTTP request header if it is going to be used as the means for providing the OAuth1 authorization information.

OAuth1 Chilkat2 Java Reference Documentation

OAuth1

Current Version: 11.7.0

Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.

OAuth 1.0 signing

Authorization header

Signed URL output

Extra signed parameters

HMAC or RSA signatures

Debuggable signing details

Object Creation

Errors

Properties

AuthorizationHeader

BaseString

ConsumerKey

ConsumerSecret

DebugLogFilePath

EncodedSignature

GeneratedUrl

HmacKey

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Nonce

OauthMethod

OauthUrl

OauthVersion

QueryString

Realm

Signature

SignatureMethod

Timestamp

Token

TokenSecret

UncommonOptions

VerboseLogging

Version

Methods

AddParam

Generate

GenNonce

GenTimestamp

RemoveParam

SetRsaKey