org.trellisldp.api.NotificationSerializationService Maven / Gradle / Ivy

Go to download

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

The core components for a Trellis linked data server

The newest version!

/*
 * Copyright (c) 2021 Aaron Coburn and individual contributors
 *
 * Licensed 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.trellisldp.api;

/**
 * A service interface for serializing an {@link Notification} object into a
 * {@link String} suitable for an external notification processor.
 *
 * @author acoburn
 */
public interface NotificationSerializationService {

    /**
     * Serialize a notification object into some concrete syntax.
     *
     * @param notification the notification
     * @return a serialization
     */
    String serialize(Notification notification);
}