com.tcdng.unify.core.UnifyContainerInterface Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unify-core Show documentation
Show all versions of unify-core Show documentation
Unify Framework: Core Components
/*
* Copyright 2018-2020 The Code Department.
*
* 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.tcdng.unify.core;
/**
* Interface with external systems for servicing requests.
*
* @author Lateef Ojulari
* @since 1.0
*/
public interface UnifyContainerInterface extends UnifyComponent {
/**
* Starts servicing web requests.
*
* @throws UnifyException
* if an error occurs
*/
void startServicingRequests() throws UnifyException;
/**
* Stops servicing web requests.
*
* @throws UnifyException
* if an error occurs
*/
void stopServicingRequests() throws UnifyException;
/**
* Returns true if interface is servicing web requests, otherwise false.
*/
boolean isServicingRequests();
/**
* Returns the interface port number.
*/
int getPort();
}