org.hawkular.btm.api.services

Class Criteria

java.lang.Object

org.hawkular.btm.api.services.Criteria

public class Criteria
extends Object

This class represents the base query criteria.

Author:

gbrown

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Criteria.FaultCriteria This class represents the fault criteria.
static class	Criteria.PropertyCriteria This class represents the property criteria.

Constructor Summary

Constructors

Constructor and Description
Criteria()

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, String value, boolean excluded) This method adds a new property criteria.
long	calculateEndTime() This method returns an end time based on the configured value.
long	calculateStartTime() This method calculates the start time to use.
Criteria	deriveTransactionWide() This method returns the transaction wide version of the current criteria.
String	getBusinessTransaction()
Set<CorrelationIdentifier>	getCorrelationIds()
long	getEndTime()
Set<Criteria.FaultCriteria>	getFaults()
String	getHostName()
long	getLowerBound()
int	getMaxResponseSize()
String	getPrincipal()
Set<Criteria.PropertyCriteria>	getProperties()
long	getStartTime()
long	getTimeout()
long	getUpperBound()
Map<String,String>	parameters() This method returns the criteria as a map of name/value pairs.
Criteria	setBusinessTransaction(String name) If a null name is used, then it will match any transaction whether it has a name or not.
Criteria	setCorrelationIds(Set<CorrelationIdentifier> correlationIds)
Criteria	setEndTime(long endTime)
Criteria	setFaults(Set<Criteria.FaultCriteria> faults)
Criteria	setHostName(String hostName)
void	setLowerBound(long lowerBound)
void	setMaxResponseSize(int maxResponseSize)
Criteria	setPrincipal(String principal)
Criteria	setProperties(Set<Criteria.PropertyCriteria> properties)
Criteria	setStartTime(long startTime)
void	setTimeout(long timeout)
void	setUpperBound(long upperBound)
String	toString()
boolean	transactionWide() This method determines if the specified criteria are relevant to all fragments within an end to end transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

Criteria

public Criteria()

Method Detail

getStartTime

public long getStartTime()

Returns:

the startTime, or 0 meaning 1 hours ago

setStartTime

public Criteria setStartTime(long startTime)

Parameters:

startTime - the startTime to set

Returns:

The criteria

calculateStartTime

public long calculateStartTime()

This method calculates the start time to use. If the configured value is 0, then it will default to an hour before the end time. If negative, then the value will be deducted from the end time.

Returns:

The calculated start time

getEndTime

public long getEndTime()

Returns:

the endTime, or 0 meaning 'current time'

setEndTime

public Criteria setEndTime(long endTime)

Parameters:

endTime - the endTime to set

Returns:

The criteria

calculateEndTime

public long calculateEndTime()

This method returns an end time based on the configured value. If end time is less or equal to 0, then its value will be deducted from the current time.

Returns:

The calculated end time

getBusinessTransaction

public String getBusinessTransaction()

Returns:

the business transaction

setBusinessTransaction

public Criteria setBusinessTransaction(String name)

If a null name is used, then it will match any transaction whether it has a name or not. If the supplied name is an empty string, then it will match only transactions that don't have a name. If a name is specified, then only transactions with that business transaction name will be selected.

Parameters:

name - the business transaction name to set

Returns:

The criteria

getProperties

public Set<Criteria.PropertyCriteria> getProperties()

Returns:

the properties

setProperties

public Criteria setProperties(Set<Criteria.PropertyCriteria> properties)

Parameters:

properties - the properties to set

Returns:

The criteria

addProperty

public void addProperty(String name,
                        String value,
                        boolean excluded)

This method adds a new property criteria.

Parameters:

name - The property name

value - The property value

excluded - Whether the specific property name/value should be excluded

getCorrelationIds

public Set<CorrelationIdentifier> getCorrelationIds()

Returns:

the correlationIds

setCorrelationIds

public Criteria setCorrelationIds(Set<CorrelationIdentifier> correlationIds)

Parameters:

correlationIds - the correlationIds to set

Returns:

The criteria

getHostName

public String getHostName()

Returns:

the hostName

setHostName

public Criteria setHostName(String hostName)

Parameters:

hostName - the hostName to set

Returns:

The criteria

getUpperBound

public long getUpperBound()

Returns:

the upperBound

setUpperBound

public void setUpperBound(long upperBound)

Parameters:

upperBound - the upperBound to set

getLowerBound

public long getLowerBound()

Returns:

the lowerBound

setLowerBound

public void setLowerBound(long lowerBound)

Parameters:

lowerBound - the lowerBound to set

getPrincipal

public String getPrincipal()

Returns:

the principal

setPrincipal

public Criteria setPrincipal(String principal)

Parameters:

principal - the principal to set

Returns:

The criteria

getFaults

public Set<Criteria.FaultCriteria> getFaults()

Returns:

the faults

setFaults

public Criteria setFaults(Set<Criteria.FaultCriteria> faults)

Parameters:

fault - the fault to set

Returns:

The criteria

getTimeout

public long getTimeout()

Returns:

the timeout

setTimeout

public void setTimeout(long timeout)

Parameters:

timeout - the timeout to set

getMaxResponseSize

public int getMaxResponseSize()

Returns:

the maxResponseSize

setMaxResponseSize

public void setMaxResponseSize(int maxResponseSize)

Parameters:

maxResponseSize - the maxResponseSize to set

parameters

public Map<String,String> parameters()

This method returns the criteria as a map of name/value pairs. The properties and correlation ids are returned as a single entry with | separators.

Returns:

The criteria parameters

transactionWide

public boolean transactionWide()

This method determines if the specified criteria are relevant to all fragments within an end to end transaction.

Returns:

Whether the criteria would apply to all fragments in a transaction

deriveTransactionWide

public Criteria deriveTransactionWide()

This method returns the transaction wide version of the current criteria.

Returns:

The transaction wide version

toString

public String toString()

Overrides:

toString in class Object