org.alembik.http
Class Constants

java.lang.Object
  org.alembik.http.Constants

public final class Constants
extends java.lang.Object

The utility class providing constant values used in HTTP API.

Since:

1.0-beta3

Field Summary

static java.lang.String	CONTENT_TYPE_PARAM The URL parameter passed in a custom status/error page redirection, which specifies a desired content type of the page to be returned to the client.
static java.lang.String	ERROR_CAUSE_PARAM The URL parameter passed in a custom error page redirection, which carries an the HTTP error code returned to the media loader of source files.
static java.lang.String	ERROR_MESSAGE_PARAM The URL parameter passed in a custom error page redirection, which carries an exception message.
static java.lang.String	ERROR_RESULT_PARAM The URL parameter passed in a custom error page redirection, which carries an return result string.
static java.lang.String	EXTENSION_DATA_PROPERTY The URL parameter substring of the HTTP service, which defines a property of an extensionData properties set.
static java.lang.String	EXTENSION_DATA_PROPERTY_SHORTCUT The URL parameter shortcut of the HTTP service for any extensionData field.
static java.lang.String	LANG_PARAM The URL parameter of the HTTP service forcing the desired HTTP request locale, which is used to choose an error image of the given language.
static java.lang.String	ORIGINATOR_ID_PARAM The URL parameter of the HTTP service setting the transcoding request's originator id.
static java.lang.String	SOURCE_LOCATION_SHORTCUT The URL parameter shortcut of the HTTP service standing for source.location field.
static java.lang.String	SOURCE_PREFIX_SHORTCUT The URL parameter shortcut of the HTTP service standing for source. prefix.
static java.lang.String	STATUS_PERCENTAGE_PARAM The URL parameter passed in a custom status page redirection, which carries the percentage of a transcoding process progress.
static java.lang.String	STATUS_PHASE_PARAM The URL parameter passed in a custom status page redirection, which carries the value of a transcoding process phase.
static java.lang.String	TARGET_PREFIX_SHORTCUT The URL parameter shortcut of the HTTP service standing for target. prefix.
static java.lang.String	TARGET_TRANSCODING_PARAMS_PREFIX_SHORTCUT The URL parameter shortcut of the HTTP service standing for target.transcodingParams. prefix.
static java.lang.String	TARGET_TRANSFORMATION_PREFIX The URL parameter prefix of the HTTP service, by which transcoding job's transformations are specified.
static java.lang.String	TARGET_TRANSFORMATION_PREFIX_SHORTCUT The URL parameter shortcut of the HTTP service standing for target.transformation. prefix.
static java.lang.String	URL_PARAM The URL parameter passed in a custom status/error page redirection, which specifies an original source location (error page) or Alembik servlet that rechecks status (status page).

Constructor Summary

Constants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ORIGINATOR_ID_PARAM

public static final java.lang.String ORIGINATOR_ID_PARAM

The URL parameter of the HTTP service setting the transcoding request's originator id.

See Also:

TranscodingRequest.setOriginatorID(String), Constant Field Values

LANG_PARAM

public static final java.lang.String LANG_PARAM

The URL parameter of the HTTP service forcing the desired HTTP request locale, which is used to choose an error image of the given language.

See Also:

Constant Field Values

SOURCE_PREFIX_SHORTCUT

public static final java.lang.String SOURCE_PREFIX_SHORTCUT

The URL parameter shortcut of the HTTP service standing for source. prefix.

See Also:

TranscodingJob.Source, Constant Field Values

TARGET_PREFIX_SHORTCUT

public static final java.lang.String TARGET_PREFIX_SHORTCUT

The URL parameter shortcut of the HTTP service standing for target. prefix.

See Also:

TranscodingJob.Target, Constant Field Values

SOURCE_LOCATION_SHORTCUT

public static final java.lang.String SOURCE_LOCATION_SHORTCUT

The URL parameter shortcut of the HTTP service standing for source.location field.

See Also:

TranscodingJob.Source.setLocation(String), Constant Field Values

TARGET_TRANSCODING_PARAMS_PREFIX_SHORTCUT

public static final java.lang.String TARGET_TRANSCODING_PARAMS_PREFIX_SHORTCUT

The URL parameter shortcut of the HTTP service standing for target.transcodingParams. prefix.

See Also:

TranscodingJob.Target.setTranscodingParams(org.openmobilealliance.schema.sti.v1_0.TranscodingParams), Constant Field Values

TARGET_TRANSFORMATION_PREFIX_SHORTCUT

public static final java.lang.String TARGET_TRANSFORMATION_PREFIX_SHORTCUT

The URL parameter shortcut of the HTTP service standing for target.transformation. prefix.

See Also:

TARGET_TRANSFORMATION_PREFIX, Constant Field Values

EXTENSION_DATA_PROPERTY_SHORTCUT

public static final java.lang.String EXTENSION_DATA_PROPERTY_SHORTCUT

The URL parameter shortcut of the HTTP service for any extensionData field.

See Also:

EXTENSION_DATA_PROPERTY, Constant Field Values

TARGET_TRANSFORMATION_PREFIX

public static final java.lang.String TARGET_TRANSFORMATION_PREFIX

The URL parameter prefix of the HTTP service, by which transcoding job's transformations are specified.

See Also:

Media.getTransformations(), Constant Field Values

EXTENSION_DATA_PROPERTY

public static final java.lang.String EXTENSION_DATA_PROPERTY

The URL parameter substring of the HTTP service, which defines a property of an extensionData properties set.

See Also:

TranscodingJob.Source.getExtensionData(), TranscodingJob.Target.getExtensionData(), Media.getExtensionData(), Constant Field Values

CONTENT_TYPE_PARAM

public static final java.lang.String CONTENT_TYPE_PARAM

The URL parameter passed in a custom status/error page redirection, which specifies a desired content type of the page to be returned to the client.

See Also:

Constant Field Values

URL_PARAM

public static final java.lang.String URL_PARAM

The URL parameter passed in a custom status/error page redirection, which specifies an original source location (error page) or Alembik servlet that rechecks status (status page).

See Also:

Constant Field Values

ERROR_MESSAGE_PARAM

public static final java.lang.String ERROR_MESSAGE_PARAM

The URL parameter passed in a custom error page redirection, which carries an exception message.

See Also:

Constant Field Values

ERROR_RESULT_PARAM

public static final java.lang.String ERROR_RESULT_PARAM

The URL parameter passed in a custom error page redirection, which carries an return result string.

See Also:

ReturnResult.getReturnString(), Constant Field Values

ERROR_CAUSE_PARAM

public static final java.lang.String ERROR_CAUSE_PARAM

The URL parameter passed in a custom error page redirection, which carries an the HTTP error code returned to the media loader of source files.

See Also:

Constant Field Values

STATUS_PHASE_PARAM

public static final java.lang.String STATUS_PHASE_PARAM

The URL parameter passed in a custom status page redirection, which carries the value of a transcoding process phase.

See Also:

Phase.value(), Constant Field Values

STATUS_PERCENTAGE_PARAM

public static final java.lang.String STATUS_PERCENTAGE_PARAM

The URL parameter passed in a custom status page redirection, which carries the percentage of a transcoding process progress.

See Also:

TranscodingState.getPercentage(), Constant Field Values

Constructor Detail

Constants

public Constants()