ro.sync.exml.plugin.urlstreamhandler

Interface URLStreamHandlerPluginExtensionConstants

All Known Subinterfaces:

TargetedURLStreamHandlerPluginExtension, URLStreamHandlerPluginExtension, URLStreamHandlerWithLockPluginExtension

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface URLStreamHandlerPluginExtensionConstants

Constants used from URLStreamHandler provider plugin extensions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADVICE_CLOSE "oxygen-action" header value instructing to close the editor.
static java.lang.String	ADVICE_RELOAD "oxygen-action" header value instructing to reload editor's content from the provided location.
static java.lang.String	LOCATION_HEADER The location header key.
static java.lang.String	OXYGEN_ACTION_HEADER The oxygen-action header key.
static java.lang.String	OXYGEN_READ_ONLY_HEADER "oxygen_read_only" header used to check if a connection is read-only.
static java.lang.String	OXYGEN_READ_ONLY_REASON_HEADER "oxygen_read_only_reason" header used to specify a reason for the document being read-only.
static java.lang.String	OXYGEN_SAVE_TYPE A header indicating the type of the save action performed.
static java.lang.String	SAVE_AS Value for the OXYGEN_SAVE_TYPE header, indicating that the user performed a Save As action.

Field Detail

LOCATION_HEADER

static final java.lang.String LOCATION_HEADER

The location header key. When saving the content through an URLConnection you can set the "location" header field to a specific value. Together with the "oxygen-action" header field value, this will instruct to refresh the editor content from the specified location or to close the editor, after performing the save operation.

See Also:

Constant Field Values

OXYGEN_ACTION_HEADER

static final java.lang.String OXYGEN_ACTION_HEADER

The oxygen-action header key. Use case: After saving content to certain CMSs, the content may be changed by the CMS or even the location can be relocated. After closing the output stream, will check the header keys of the URLConnection for the "location" and "oxygen-action" keys. If the "oxygen-action" key is found and the value is a supported one: "reload" or "close" values, will act accordingly.

See Also:

Constant Field Values

ADVICE_RELOAD

static final java.lang.String ADVICE_RELOAD

"oxygen-action" header value instructing to reload editor's content from the provided location.

See Also:

Constant Field Values

ADVICE_CLOSE

static final java.lang.String ADVICE_CLOSE

"oxygen-action" header value instructing to close the editor.

See Also:

Constant Field Values

OXYGEN_READ_ONLY_HEADER

static final java.lang.String OXYGEN_READ_ONLY_HEADER

"oxygen_read_only" header used to check if a connection is read-only.

See Also:

Constant Field Values

OXYGEN_READ_ONLY_REASON_HEADER

static final java.lang.String OXYGEN_READ_ONLY_REASON_HEADER

"oxygen_read_only_reason" header used to specify a reason for the document being read-only.

Since:

18.0

See Also:

Constant Field Values

OXYGEN_SAVE_TYPE

static final java.lang.String OXYGEN_SAVE_TYPE

A header indicating the type of the save action performed. If absent, a normal save was performed.

See Also:

Constant Field Values

SAVE_AS

static final java.lang.String SAVE_AS

Value for the OXYGEN_SAVE_TYPE header, indicating that the user performed a Save As action.

See Also:

Constant Field Values