se.swedenconnect.signservice.context.SignServiceContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of signservice-core Show documentation
SignService Core Library
There is a newer version: 1.1.3
/*
 * Copyright 2022-2024 Sweden Connect
 *
 * 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.
 */
package se.swedenconnect.signservice.context;

import java.io.Serializable;

import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;

/**
 * The {@code SignServiceContext} holds the current context and state for a signature operation.
 */
public interface SignServiceContext extends Serializable {

  /**
   * Gets the unique ID for the current operation. This ID should be included in all logs (process- and audit logs).
   *
   * @return the unique ID for the operation
   */
  @Nonnull
  String getId();

  /**
   * Stores a data element in the context.
   *
   * @param  the type of the element
   * @param name the unique name of the element
   * @param data the element to store
   */
   void put(@Nonnull final String name, @Nullable final T data);

  /**
   * Gets a named data element from the context.
   *
   * @param  the type of the element
   * @param name the unique name of the element
   * @return the element, or null if no matching element is available
   */
  @Nullable
   T get(@Nonnull final String name);

  /**
   * Gets a named data element having a given type from the context.
   *
   * @param  the type of the element
   * @param name the unique name of the element
   * @param type the type of the element
   * @return the element, or null if no matching element is available
   * @throws ClassCastException if the element exists but is not of the given type
   */
  @Nullable
   T get(@Nonnull final String name, @Nonnull final Class type) throws ClassCastException;

  /**
   * Removes the named element from the context.
   * 
   * The rationale behind this method is that a module that writes a large data element to the context should be able to
   * remove it when it os no longer needed. In this way, storing the context is cheaper.
   * 
   *
   * @param  the type of the element
   * @param name the unique name of the element
   */
   void remove(@Nonnull final String name);

  /**
   * Serializes the context to its string representation/encoding.
   *
   * @return the string encoding of the context object
   */
  @Nonnull
  String serialize();

}