com.wedeploy.api.sdk.Data Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of Liferay, Inc. nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.wedeploy.api.sdk;
/**
* Data context.
*/
public interface Data {
/**
* Commits the data operation wrapped by this request handler.
* The response is set, but not ended. You must end the response in the
* handler as you would naturally.
* Returns true if operation executed successfully,
* false otherwise.
*/
public boolean commit();
/**
* Commits the data operation using the given value as request body.
*
* @see #commit()
*/
public boolean commit(Object value);
/**
* Creates a data snapshot.
*/
public DataSnapshot snapshot();
/**
* Retrieves a snapshot of the existing data.
*/
public T storedValue();
/**
* Retrieves a snapshot of the existing data and parses into the target type.
*
* @see #storedValue()
*/
public T storedValue(Class type);
/**
* Parses the body depending on content-type. If content-type is NOT set,
* it will use assume the "plain/text" content type.
* Returns {@link Request#bodyValue()} if data not committed,
* {@link Response#bodyValue()} otherwise.
* If body is not set, returns null.
* If body can not be parsed, throws an Exception.
*
* @see #commit()
*/
public T value();
/**
* Parses the body depending on content-type into the target type.
*
* @see #value()
*/
public T value(Class type);
}