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
FieldsModifier and TypeFieldDescriptionstatic final String
"oxygen-action" header value instructing Oxygen to close the editor.static final String
"oxygen-action" header value instructing Oxygen to reload editor's content from the provided location.static final String
The location header key.static final String
The oxygen-action header key.static final String
"oxygen_read_only" header used to check if a connection is read-only.static final String
"oxygen_read_only_reason_code" header used to specify a code for the reason for the document being read-only.static final String
"oxygen_read_only_reason" header used to specify a reason for the document being read-only.static final String
A header indicating the type of the save action performed.static final String
Value for theOXYGEN_SAVE_TYPE
header, indicating that the user performed a Save As action.static final String
Value for theOXYGEN_SAVE_TYPE
header, indicating that an automatic save was performed.
-
Field Details
-
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 Oxygen to refresh the editor content from the specified location or to close the editor, after performing the save operation.- See Also:
-
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, Oxygen 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, Oxygen will act accordingly.- See Also:
-
ADVICE_RELOAD
"oxygen-action" header value instructing Oxygen to reload editor's content from the provided location.- See Also:
-
ADVICE_CLOSE
"oxygen-action" header value instructing Oxygen to close the editor.- See Also:
-
OXYGEN_READ_ONLY_HEADER
"oxygen_read_only" header used to check if a connection is read-only.- See Also:
-
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:
-
OXYGEN_READ_ONLY_REASON_CODE_HEADER
"oxygen_read_only_reason_code" header used to specify a code for the reason for the document being read-only.- Since:
- 19.1
- See Also:
-
OXYGEN_SAVE_TYPE
A header indicating the type of the save action performed. If absent, a normal save was performed.- See Also:
-
SAVE_AS
Value for theOXYGEN_SAVE_TYPE
header, indicating that the user performed a Save As action.- See Also:
-
SAVE_AUTO
Value for theOXYGEN_SAVE_TYPE
header, indicating that an automatic save was performed.- Since:
- 21.1
- See Also:
-