org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard 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.jackrabbit.oak.spi.whiteboard;

import java.util.Map;

import org.osgi.annotation.versioning.ProviderType;

@ProviderType
public interface Whiteboard {

    /**
     * Publishes the given service to the whiteboard. Use the returned
     * registration object to unregister the service.
     *
     * @param type type of the service
     * @param service service instance
     * @param properties service properties. Those need to use {@link String} keys, but for backwards compatibility reasons this is not enforced via generics.
     * @return service registration
     */
     Registration register(Class type, T service, Map properties);

    /**
     * Starts tracking services of the given type.
     *
     * @param type type of the services to track
     * @return service tracker
     */
     Tracker track(Class type);

    /**
     * Starts tracking services of the given type, with given attributes.
     *
     * @param type type of the services to track
     * @param filterProperties only services with these properties will be tracked.
     *                         Null keys are not permitted. Null values means that
     *                         the property should be absent.
     * @return service tracker
     */
     Tracker track(Class type, Map filterProperties);

}