blob: ed5ad051a8b9606914978ded5c7a52abac384609 [file] [log] [blame]
/*
* 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.nifi.websocket;
import org.apache.nifi.annotation.documentation.CapabilityDescription;
import org.apache.nifi.annotation.lifecycle.OnDisabled;
import org.apache.nifi.annotation.lifecycle.OnEnabled;
import org.apache.nifi.annotation.lifecycle.OnShutdown;
import org.apache.nifi.controller.ConfigurationContext;
/**
* Control an embedded WebSocket server instance.
*/
@CapabilityDescription("Control an embedded WebSocket server instance," +
" so that external system can connect this NiFi via WebSocket protocol.")
public interface WebSocketServerService extends WebSocketService {
@OnEnabled
void startServer(final ConfigurationContext context) throws Exception;
@OnDisabled
@OnShutdown
void stopServer() throws Exception;
}