001/**
002 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
003 *   This file is part of the LDP4j Project:
004 *     http://www.ldp4j.org/
005 *
006 *   Center for Open Middleware
007 *     http://www.centeropenmiddleware.com/
008 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
009 *   Copyright (C) 2014 Center for Open Middleware.
010 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
011 *   Licensed under the Apache License, Version 2.0 (the "License");
012 *   you may not use this file except in compliance with the License.
013 *   You may obtain a copy of the License at
014 *
015 *             http://www.apache.org/licenses/LICENSE-2.0
016 *
017 *   Unless required by applicable law or agreed to in writing, software
018 *   distributed under the License is distributed on an "AS IS" BASIS,
019 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 *   See the License for the specific language governing permissions and
021 *   limitations under the License.
022 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
023 *   Artifact    : org.ldp4j.framework:ldp4j-application-api:0.2.0
024 *   Bundle      : ldp4j-application-api-0.2.0.jar
025 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
026 */
027package org.ldp4j.application.ext;
028
029import org.ldp4j.application.session.ResourceSnapshot;
030import org.ldp4j.application.session.WriteSession;
031import org.ldp4j.application.data.DataSet;
032
033/**
034 * Interface to be implemented by {@link ResourceHandler} implementations that
035 * also support resource modification.
036 */
037public interface Modifiable {
038
039  /**
040   * Update the state of a resource managed by a handler.
041   *
042   * @param resource
043   *            the resource whose state is to be updated.
044   * @param content
045   *            the new content for the resource.
046   * @param session
047   *            the session to use for registering the side effects of the
048   *            operation.
049   * @throws UnknownResourceException
050   *             if the handler does not manage the specified resource.
051   * @throws UnsupportedContentException
052   *             if the resource cannot be updated with the specified
053   *             contents.
054   * @throws InconsistentContentException
055   *             if the specified contents include values that modify current
056   *             values of server managed properties.
057   * @throws ApplicationRuntimeException
058   *             if internal exception prevents the update of the resource.
059   */
060  void update(ResourceSnapshot resource, DataSet content, WriteSession session)
061      throws
062        UnknownResourceException,
063        UnsupportedContentException,
064        InconsistentContentException;
065
066}