io.apiman.manager.api.core.util

Class EntityValidator

java.lang.Object

io.apiman.manager.api.core.util.EntityValidator

All Implemented Interfaces:

IApplicationValidator, IServiceValidator

public class EntityValidator
extends Object
implements IServiceValidator, IApplicationValidator

Validates the state of various entities, including services and applications.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
EntityValidator() Constructor.

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.
IStorageQuery	getStorageQuery()
boolean	isReady(io.apiman.manager.api.beans.apps.ApplicationVersionBean application) Is the given application Ready to be registered with the Gateway? This method will return true if all of the criteria for registration is met.
boolean	isReady(io.apiman.manager.api.beans.apps.ApplicationVersionBean application, boolean hasContracts) Is the given application Ready to be registered with the Gateway? This method will return true if all of the criteria for registration is met.
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.
void	setStorageQuery(IStorageQuery storageQuery)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityValidator

public EntityValidator()

Constructor.

Method Detail

isReady

public boolean isReady(io.apiman.manager.api.beans.apps.ApplicationVersionBean application)
                throws Exception

Description copied from interface: IApplicationValidator

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

• At least one Service Contract exists for the application

Specified by:

isReady in interface IApplicationValidator

Returns:

true if ready, else false

Throws:

Exception

See Also:

IApplicationValidator.isReady(io.apiman.manager.api.beans.apps.ApplicationVersionBean)

isReady

public boolean isReady(io.apiman.manager.api.beans.apps.ApplicationVersionBean application,
                       boolean hasContracts)
                throws Exception

Description copied from interface: IApplicationValidator

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

• At least one Service Contract exists for the application

This version of isRead() skips the check for contracts and instead uses the value passed in. This is important if, for example, a contract is being created.

Specified by:

isReady in interface IApplicationValidator

Returns:

true if ready, else false

Throws:

Exception

See Also:

IApplicationValidator.isReady(io.apiman.manager.api.beans.apps.ApplicationVersionBean, boolean)

isReady

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

Description copied from interface: IServiceValidator

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

Specified by:

isReady in interface IServiceValidator

Returns:

true if ready, else false

See Also:

IServiceValidator.isReady(io.apiman.manager.api.beans.services.ServiceVersionBean)

getStatus

public 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)

Description copied from interface: IServiceValidator

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?".

Specified by:

getStatus in interface IServiceValidator

See Also:

IServiceValidator.getStatus(io.apiman.manager.api.beans.services.ServiceVersionBean, java.util.List)

getStorageQuery

public IStorageQuery getStorageQuery()

Returns:

the storageQuery

setStorageQuery

public void setStorageQuery(IStorageQuery storageQuery)

Parameters:

storageQuery - the storageQuery to set