com.symphony.oss.models.fundmental.canon.IObjectsObjectHashPathHandler Maven / Gradle / Ivy

Go to download
/**
 * GENERATED CODE - DO NOT EDIT OR CHECK IN TO SOURCE CODE CONTROL
 *
 * Copyright 2020 Symphony Communication Services, LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 *----------------------------------------------------------------------------------------------------
 * Generated from
 *    Input source         file:/Users/bruce/symphony/git-SymphonyOSF/oss-models/target/checkout/fundamental-model/src/main/resources/canon/fundamental.json
 *    Template groupId     org.symphonyoss.s2.canon
 *           artifactId    canon-template-java
 *    Template name        template/java/Path/I_PathHandler.java.ftl
 *    At                   2020-01-28 16:55:36 GMT
 *----------------------------------------------------------------------------------------------------
 */

package com.symphony.oss.models.fundmental.canon;

import java.util.List;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.symphonyoss.s2.canon.runtime.exception.CanonException;
import org.symphonyoss.s2.canon.runtime.http.IRequestAuthenticator;
import org.symphonyoss.s2.canon.runtime.IEntityHandler;
import org.symphonyoss.s2.fugue.core.trace.ITraceContext;

import org.symphonyoss.s2.common.immutable.ImmutableByteArray;
import org.symphonyoss.s2.common.hash.Hash;
import com.symphony.oss.models.fundamental.canon.facade.*;
import com.symphony.oss.models.crypto.canon.facade.*;
import com.symphony.oss.models.crypto.canon.*;
import com.symphony.oss.models.core.canon.facade.*;
import com.symphony.oss.models.core.canon.*;

/**
 * Path name=ObjectsObjectHash
 *
 * Path					/objects/{objectHash}
 * Bind Path			objects/
 */
public interface IObjectsObjectHashPathHandler extends IEntityHandler
{
  /**
   * get /objects/{objectHash}
   * Read an object
   * @param canonAuth An authentication token.
   * @param canonTrace A trace context.
   * @param currentVersion            No summary given.
   * @param traceContextHash          No summary given.
   * @param objectHash                No summary given.
   * @return A IFundamentalObject
   * or null
   * @throws CanonException                    If the method cannot be called
   */
  @Nullable IFundamentalObject handleGet(
              T canonAuth, 
              ITraceContext             canonTrace,
    @Nullable Boolean                   currentVersion,
    @Nullable Hash                      traceContextHash,
    @Nonnull  Hash                      objectHash	
    ) throws CanonException;
    
  /**
   * put /objects/{objectHash}
   * Create an object
   * @param canonPayload The request payload
   * @param canonAuth An authentication token.
   * @param canonTrace A trace context.
   * @param traceContextHash          No summary given.
   * @param objectHash                No summary given.
   * @throws CanonException                    If the method cannot be called
   */
  void handlePut(
    @Nonnull  IFundamentalObject        canonPayload,
              T canonAuth, 
              ITraceContext             canonTrace,
    @Nullable Hash                      traceContextHash,
    @Nonnull  Hash                      objectHash	
    ) throws CanonException;
    
}
/*----------------------------------------------------------------------------------------------------
 * End of template template/java/Path/I_PathHandler.java.ftl
 * End of code generation
 *------------------------------------------------------------------------------------------------- */