Package fr.gouv.vitam.storage.engine.server.storagelog.parameters

Enum StorageLogbookParameterName

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StorageLogbookParameterName>
    public enum StorageLogbookParameterName
extends java.lang.Enum<StorageLogbookParameterName>
    Enum with all possible logbook storage parameters

    Use to set parameter value and to check emptiness or nullity

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      agentIdentifierRequester
      Requester of the storage order
      agentIdentifiers
      List of the offers identifiers on which the object has been written
      applicationId
      Application-Id
      archivesId
      Archive Units ID with contains the object
      contextId
      Context Id of the request
      contractId
      Access Contract Id of the request
      dataCategory
      Data category
      digest
      Digest of the written object.
      digestAlgorithm
      digest Algorithm used for this object Could be for instance: "SHA-256", "SHA-512", ...
      eventDateTime
      Set by the storage engine : date time of the event
      eventType
      Event type: should use one global Enum ActionType

      Could be for instance: "Unzip", "CheckSeda", ...
      objectGroupIdentifier
      Object Group Identifier.
      Identifier of the object group corresponding to the object written in the storage offer.
      objectIdentifier
      Object Identifier.
      Identifier of the object to be written in the storage offer.
      objectSize
      Object Size
      outcome
      Status between: "OK", "KO", "PENDING"

      One must use the StorageLogbookOutcome enum.
      qualifier
      Object qualifier in the objectGroup
      size
      Size in bytes of the object written on the storage offer
      tenantId
      Tenant ID
      version
      Object version in the objectGroup
      xRequestId
      X-Request-Id

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static StorageLogbookParameterName valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static StorageLogbookParameterName[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static StorageLogbookParameterName[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (StorageLogbookParameterName c : StorageLogbookParameterName.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static StorageLogbookParameterName valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null