001/* 002 * Licensed to DuraSpace under one or more contributor license agreements. 003 * See the NOTICE file distributed with this work for additional information 004 * regarding copyright ownership. 005 * 006 * DuraSpace licenses this file to you under the Apache License, 007 * Version 2.0 (the "License"); you may not use this file except in 008 * compliance with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, software 013 * distributed under the License is distributed on an "AS IS" BASIS, 014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 015 * See the License for the specific language governing permissions and 016 * limitations under the License. 017 */ 018package org.fcrepo.kernel.api.services; 019 020import org.fcrepo.kernel.api.Transaction; 021import org.fcrepo.kernel.api.identifiers.FedoraId; 022 023import java.time.format.DateTimeFormatter; 024 025import static java.time.ZoneOffset.UTC; 026import static java.time.format.DateTimeFormatter.RFC_1123_DATE_TIME; 027 028/** 029 * Service for creating versions of resources 030 * 031 * @author bbpennel 032 * @author whikloj 033 * @since Feb 19, 2014 034 */ 035public interface VersionService { 036 037 /** 038 * To format a datetime for use as a Memento path. 039 */ 040 DateTimeFormatter MEMENTO_LABEL_FORMATTER = DateTimeFormatter.ofPattern("yyyyMMddHHmmss") 041 .withZone(UTC); 042 043 /** 044 * To format a datetime as RFC-1123 with correct timezone. 045 */ 046 DateTimeFormatter MEMENTO_RFC_1123_FORMATTER = RFC_1123_DATE_TIME.withZone(UTC); 047 048 /** 049 * Explicitly creates a version for the resource at the path provided. 050 * 051 * @param transaction the transaction in which the resource resides 052 * @param fedoraId the internal resource id 053 * @param userPrincipal the user principal 054 */ 055 void createVersion(Transaction transaction, FedoraId fedoraId, String userPrincipal); 056 057}