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-2016 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.2
024 *   Bundle      : ldp4j-application-api-0.2.2.jar
025 * #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=#
026 */
027package org.ldp4j.application.ext;
028
029import org.ldp4j.application.session.ContainerSnapshot;
030import org.ldp4j.application.session.ResourceSnapshot;
031import org.ldp4j.application.session.WriteSession;
032import org.ldp4j.application.data.DataSet;
033
034/**
035 * Interface to be implemented for handling Container LDP resources. <br>
036 * <br>
037 *
038 * Handler implementations can be further extended by implementing the
039 * {@link Deletable} and/or {@link Modifiable} interfaces.
040 */
041public interface ContainerHandler extends ResourceHandler {
042
043  /**
044   * Creates a member of a container managed by the container handler.
045   *
046   * @param container
047   *            the container to which a member will be added.
048   * @param representation
049   *            the representation of the member that will be created.
050   * @param session
051   *            the session to use for registering the side effects of the
052   *            operation.
053   * @return the resource created.
054   * @throws UnknownResourceException
055   *             if the container handler does not manage the specified
056   *             container.
057   * @throws UnsupportedContentException
058   *             if the specified contents are not valid for creating the
059   *             member of the container.
060   * @throws ApplicationRuntimeException
061   *             if an internal exception prevents the creation of the member
062   *             resource.
063   */
064  ResourceSnapshot create(ContainerSnapshot container, DataSet representation, WriteSession session)
065      throws UnknownResourceException, UnsupportedContentException;
066
067}