com.kdgregory.logging.aws.facade.SNSFacade Maven / Gradle / Ivy
Show all versions of logwriters Show documentation
// Copyright (c) Keith D Gregory
//
// 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 com.kdgregory.logging.aws.facade;
import com.kdgregory.logging.common.LogMessage;
/**
* Exposes the CloudWatch Logs APIs used by SNShLogWriter.
*
* Instances are created by {@link FacadeFactory}, and are tied to a single
* writer's configuration.
*
* All operations may throw {@link SNSFacadeException}. Callers are expected to
* catch this exception (it's checked), and take action based on the reason code
* that it exposes.
*/
public interface SNSFacade
{
/**
* Attempts to match the configured topic ARN or name to an existing SNS
* topic in the configured account and region. Returns the topic ARN if
* found, null if not found. Throws if unable to retrieve topic information
* for any reason, including throttling.
*/
String lookupTopic();
/**
* Attempts to create a topic with the configured name. Returns the topic's
* ARN if successful, throws on any failure.
*
* Note: SNS silently succeeds if the topic already exists.
*/
String createTopic();
/**
* Attempts to publish the provided message, using configured topic and subject.
*
* Throws if unable, including throttling.
*/
void publish(LogMessage message);
/**
* Shuts down the underlying client.
*/
void shutdown();
}