001/*
002 * Copyright 2015 DuraSpace, Inc.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.fcrepo.migration;
017
018/**
019 * An interface defining a method to replace one URL (represented as a String) with another.
020 * In the context of migrating objects from fedora 3 to fedora 4, there may be a need to
021 * make programmatic updates to the URLs founds in External or Redirect datastreams.  This
022 * interface is for that purpose.
023 *
024 * @author Mike Durbin
025 */
026public interface ExternalContentURLMapper {
027
028    /**
029     * @param url to be mapped
030     *
031     * @return the String containing a URL that should be used instead of the given String
032     * for migrated external or redirect datastreams.
033     */
034    public String mapURL(String url);
035}