org.apache.sling.sitemap.SitemapInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.sling.sitemap;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.annotation.versioning.ProviderType;

/**
 * An info object with details about a sitemap/sitemap-index.
 */
@ProviderType
public interface SitemapInfo {

    enum Status {
        /**
         * Sitemap is available but served on-demand.
         */
        ON_DEMAND,
        /**
         * Sitemap is available and served from storage.
         */
        STORAGE,
        /**
         * Sitemap is not yet available, generation is pending.
         */
        SCHEDULED,
        /**
         * Sitemap not served on-demand, not served from storage, no schedule registered.
         * 
         * That may mean the sitemap is generated on a different host.
         */
        UNKNOWN
    }

    /**
     * Returns the resource path to the resource the sitemap is stored at. May return null if the sitemap or
     * sitemap-index is served on-demand.
     *
     * @return
     */
    @Nullable
    String getStoragePath();

    /**
     * Returns the absolute, external url for the sitemap/sitemap-index.
     *
     * @return
     */
    @NotNull
    String getUrl();

    /**
     * Returns the name of the sitemap.
     * 
     * For sitemap-indexes this will be equal to {@link SitemapService#SITEMAP_INDEX_NAME} and for sitemaps generated
     * for the default name this will be equal to {@link SitemapService#DEFAULT_SITEMAP_NAME}.
     *
     * @return
     */
    @NotNull
    String getName();

    /**
     * Returns the status of the sitemap.
     *
     * @return
     * @see SitemapInfo.Status
     */
    @NotNull
    Status getStatus();

    /**
     * Returns the size of the sitemap in bytes. -1 for sitemap-index or sitemaps served on-demand.
     *
     * @return
     */
    int getSize();

    /**
     * Returns the number of urls in the sitemap. -1 for sitemap-index or sitemaps served on-demand.
     *
     * @return
     */
    int getEntries();

}