io.apiman.manager.api.core

Interface IServiceValidator

All Known Implementing Classes:

EntityValidator

public interface IServiceValidator

Validates the state of services and service versions.

Author:

eric.wittmann@redhat.com

Method Summary

Modifier and Type	Method and Description
io.apiman.manager.api.beans.services.ServiceVersionStatusBean	getStatus(io.apiman.manager.api.beans.services.ServiceVersionBean service, List<io.apiman.manager.api.beans.summary.PolicySummaryBean> policies) Returns detailed status information about a service, including precisely why the service is in the status it's currently in.
boolean	isReady(io.apiman.manager.api.beans.services.ServiceVersionBean service) Is the given service Ready to be published to the Gateway? This method will return true if all of the criteria for publishing is met.

Method Detail

isReady

boolean isReady(io.apiman.manager.api.beans.services.ServiceVersionBean service)
         throws Exception

Is the given service Ready to be published to the Gateway? This method will return true if all of the criteria for publishing is met. The criteria includes (but is not necessarily limited to):

• A service implementation endpoint is set
• At least one Plan is selected for use

Parameters:

service -

Returns:

true if ready, else false

Throws:

Exception

getStatus

io.apiman.manager.api.beans.services.ServiceVersionStatusBean getStatus(io.apiman.manager.api.beans.services.ServiceVersionBean service,
                                                                        List<io.apiman.manager.api.beans.summary.PolicySummaryBean> policies)

Returns detailed status information about a service, including precisely why the service is in the status it's currently in. For example, this will answer the question "why can't the service be published?".

Parameters:

service -

policies -