GrouperMessageHibernate (Grouper API 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouper.GrouperAPI
- - edu.internet2.middleware.grouper.messaging.GrouperMessageHibernate

All Implemented Interfaces:

HibGrouperLifecycle, Hib3GrouperVersioned, GrouperCloneable, GrouperUtil.FieldValuable, GrouperMessage, Serializable, org.hibernate.classic.Lifecycle
```
public class GrouperMessageHibernate
extends GrouperAPI
implements GrouperMessage, Hib3GrouperVersioned
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COLUMN_ATTEMPT_TIME_EXPIRES_MILLIS` milliseconds since 1970 that the message was attempted to be received
`static String`	`COLUMN_FROM_MEMBER_ID` member id of user who sent the message
`static String`	`COLUMN_GET_ATTEMPT_COUNT` how many times this message has been attempted to be retrieved
`static String`	`COLUMN_GET_ATTEMPT_TIME_MILLIS` milliseconds since 1970 that the message was attempted to be received
`static String`	`COLUMN_GET_TIME_MILLIS` millis since 1970 that this message was successfully received
`static String`	`COLUMN_HIBERNATE_VERSION_NUMBER` hibernate version
`static String`	`COLUMN_ID` db uuid for this row
`static String`	`COLUMN_MESSAGE_BODY` message body
`static String`	`COLUMN_QUEUE_NAME` queue name for the message
`static String`	`COLUMN_SENT_TIME_MICROS` microseconds since 1970 this message was sent (note this is probably unique, but not necessarily)
`static String`	`COLUMN_STATE` state of this message: IN_QUEUE, GET_ATTEMPTED, PROCESSED
`static String`	`FIELD_CONTEXT_ID` constant for field name for: contextId
`static String`	`FIELD_ID` constant for field name for: id
`static String`	`TABLE_GROUPER_MESSAGE` name of the table in the database.

Fields inherited from class edu.internet2.middleware.grouper.GrouperAPI
dbVersion, FIELD_DB_VERSION, FIELD_HIBERNATE_VERSION_NUMBER, INITIAL_VERSION_NUMBER

Fields inherited from interface org.hibernate.classic.Lifecycle
NO_VETO, VETO

Constructor Summary

Constructors
Constructor and Description

GrouperMessageHibernate()

Constructors
Constructor and Description
`GrouperMessageHibernate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GrouperAPI`	`clone()` deep clone the fields in this object
`void`	`delete()` delete this object
`Long`	`getAttemptTimeExpiresMillis()` millis since 1970 that this message attempt expires if not sent successfully note this will be reset to null when message sent successfully
`String`	`getContextId()`
`String`	`getFromMemberId()`
`Integer`	`getGetAttemptCount()` how many times this message has been attempted to be retrieved
`Long`	`getGetAttemptTimeMillis()` milliseconds since 1970 that the message was attempted to be received
`Long`	`getGetTimeMillis()` millis since 1970 that this message was successfully received
`String`	`getId()`
`String`	`getMessageBody()` body of message (e.g.
`String`	`getQueueName()` queue name for the message
`String`	`getQueueOrTopic()`
`Long`	`getSentTimeMicros()` millis since 1970 that this message was sent
`String`	`getState()` state of this message: IN_QUEUE, GET_ATTEMPTED, PROCESSED
`void`	`saveOrUpdate()` save or update this object
`void`	`setAttemptTimeExpiresMillis(Long attemptTimeExpiresMillis1)` millis since 1970 that this message attempt expires if not sent successfully note this will be reset to null when message sent successfully
`void`	`setContextId(String contextId1)` set context id
`void`	`setFromMemberId(String fromMemberId1)`
`void`	`setGetAttemptCount(Integer getAttemptCount1)`
`void`	`setGetAttemptTimeMillis(Long getAttemptTimeMillis1)` milliseconds since 1970 that the message was attempted to be received
`void`	`setGetTimeMillis(Long getTimeMillis1)` millis since 1970 that this message was successfully received
`void`	`setId(String id1)`
`void`	`setMessageBody(String messageBody1)` body of message (e.g.
`void`	`setQueueName(String queueName1)` queue name for the message
`void`	`setQueueOrTopic(String theQueueOrTopic1)`
`void`	`setSentTimeMicros(Long sentTimeMicros1)` millis since 1970 that this message was sent
`void`	`setState(String state1)` state of this message: IN_QUEUE, GET_ATTEMPTED, PROCESSED

Methods inherited from class edu.internet2.middleware.grouper.GrouperAPI
dbVersion, dbVersionClear, dbVersionDifferentFields, dbVersionIsDifferent, dbVersionReset, fieldValue, getHibernateVersionNumber, onDelete, onLoad, onPostDelete, onPostSave, onPostUpdate, onPreDelete, onPreSave, onPreUpdate, onSave, onUpdate, setHibernateVersionNumber

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COLUMN_ID
```
public static final String COLUMN_ID
```
    db uuid for this row
    
    See Also:
    
    Constant Field Values
  - COLUMN_HIBERNATE_VERSION_NUMBER
```
public static final String COLUMN_HIBERNATE_VERSION_NUMBER
```
    hibernate version
    
    See Also:
    
    Constant Field Values
  - FIELD_CONTEXT_ID
```
public static final String FIELD_CONTEXT_ID
```
    constant for field name for: contextId
    
    See Also:
    
    Constant Field Values
  - FIELD_ID
```
public static final String FIELD_ID
```
    constant for field name for: id
    
    See Also:
    
    Constant Field Values
  - COLUMN_SENT_TIME_MICROS
```
public static final String COLUMN_SENT_TIME_MICROS
```
    microseconds since 1970 this message was sent (note this is probably unique, but not necessarily)
    
    See Also:
    
    Constant Field Values
  - COLUMN_GET_ATTEMPT_TIME_MILLIS
```
public static final String COLUMN_GET_ATTEMPT_TIME_MILLIS
```
    milliseconds since 1970 that the message was attempted to be received
    
    See Also:
    
    Constant Field Values
  - COLUMN_ATTEMPT_TIME_EXPIRES_MILLIS
```
public static final String COLUMN_ATTEMPT_TIME_EXPIRES_MILLIS
```
    milliseconds since 1970 that the message was attempted to be received
    
    See Also:
    
    Constant Field Values
  - COLUMN_GET_ATTEMPT_COUNT
```
public static final String COLUMN_GET_ATTEMPT_COUNT
```
    how many times this message has been attempted to be retrieved
    
    See Also:
    
    Constant Field Values
  - COLUMN_STATE
```
public static final String COLUMN_STATE
```
    state of this message: IN_QUEUE, GET_ATTEMPTED, PROCESSED
    
    See Also:
    
    Constant Field Values
  - COLUMN_GET_TIME_MILLIS
```
public static final String COLUMN_GET_TIME_MILLIS
```
    millis since 1970 that this message was successfully received
    
    See Also:
    
    Constant Field Values
  - COLUMN_FROM_MEMBER_ID
```
public static final String COLUMN_FROM_MEMBER_ID
```
    member id of user who sent the message
    
    See Also:
    
    Constant Field Values
  - COLUMN_QUEUE_NAME
```
public static final String COLUMN_QUEUE_NAME
```
    queue name for the message
    
    See Also:
    
    Constant Field Values
  - COLUMN_MESSAGE_BODY
```
public static final String COLUMN_MESSAGE_BODY
```
    message body
    
    See Also:
    
    Constant Field Values
  - TABLE_GROUPER_MESSAGE
```
public static final String TABLE_GROUPER_MESSAGE
```
    name of the table in the database.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GrouperMessageHibernate
```
public GrouperMessageHibernate()
```
- Method Detail
  - getAttemptTimeExpiresMillis
```
public Long getAttemptTimeExpiresMillis()
```
    millis since 1970 that this message attempt expires if not sent successfully note this will be reset to null when message sent successfully
    
    Returns:
    
    the attemptTimeExpiresMillis
  - setAttemptTimeExpiresMillis
```
public void setAttemptTimeExpiresMillis(Long attemptTimeExpiresMillis1)
```
    millis since 1970 that this message attempt expires if not sent successfully note this will be reset to null when message sent successfully
    
    Parameters:
    
    attemptTimeExpiresMillis1 - the attemptTimeExpiresMillis to set
  - getState
```
public String getState()
```
    state of this message: IN_QUEUE, GET_ATTEMPTED, PROCESSED
    
    Returns:
    
    the state
  - setState
```
public void setState(String state1)
```
    state of this message: IN_QUEUE, GET_ATTEMPTED, PROCESSED
    
    Parameters:
    
    state1 - the state to set
  - setId
```
public void setId(String id1)
```
    Specified by:
    
    setId in interface GrouperMessage
    
    Parameters:
    
    id1 - the id to set
  - getFromMemberId
```
public String getFromMemberId()
```
    Specified by:
    
    getFromMemberId in interface GrouperMessage
    
    See Also:
    
    GrouperMessage.getFromMemberId()
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface GrouperMessage
    
    Returns:
    
    id
  - getMessageBody
```
public String getMessageBody()
```
    body of message (e.g. the json or encrypted message)
    
    Specified by:
    
    getMessageBody in interface GrouperMessage
    
    Returns:
    
    the messageBody
  - setFromMemberId
```
public void setFromMemberId(String fromMemberId1)
```
    Specified by:
    
    setFromMemberId in interface GrouperMessage
    
    See Also:
    
    GrouperMessage.setFromMemberId(java.lang.String)
  - setMessageBody
```
public void setMessageBody(String messageBody1)
```
    body of message (e.g. the json or encrypted message)
    
    Specified by:
    
    setMessageBody in interface GrouperMessage
    
    Parameters:
    
    messageBody1 - the messageBody to set
  - getSentTimeMicros
```
public Long getSentTimeMicros()
```
    millis since 1970 that this message was sent
    
    Returns:
    
    the sentTimeMicros
  - setSentTimeMicros
```
public void setSentTimeMicros(Long sentTimeMicros1)
```
    millis since 1970 that this message was sent
    
    Parameters:
    
    sentTimeMicros1 - the sentTimeMicros to set
  - getQueueName
```
public String getQueueName()
```
    queue name for the message
    
    Returns:
    
    the queueName
  - setQueueName
```
public void setQueueName(String queueName1)
```
    queue name for the message
    
    Parameters:
    
    queueName1 - the queueName to set
  - getGetTimeMillis
```
public Long getGetTimeMillis()
```
    millis since 1970 that this message was successfully received
    
    Returns:
    
    the getTimeMillis
  - setGetTimeMillis
```
public void setGetTimeMillis(Long getTimeMillis1)
```
    millis since 1970 that this message was successfully received
    
    Parameters:
    
    getTimeMillis1 - the getTimeMillis to set
  - getGetAttemptTimeMillis
```
public Long getGetAttemptTimeMillis()
```
    milliseconds since 1970 that the message was attempted to be received
    
    Returns:
    
    the getAttemptTimeMillis
  - setGetAttemptTimeMillis
```
public void setGetAttemptTimeMillis(Long getAttemptTimeMillis1)
```
    milliseconds since 1970 that the message was attempted to be received
    
    Parameters:
    
    getAttemptTimeMillis1 - the getAttemptTimeMillis to set
  - getGetAttemptCount
```
public Integer getGetAttemptCount()
```
    how many times this message has been attempted to be retrieved
    
    Returns:
    
    the getAttemptCount
  - setGetAttemptCount
```
public void setGetAttemptCount(Integer getAttemptCount1)
```
    Parameters:
    
    getAttemptCount1 - the getAttemptCount to set
  - clone
```
public GrouperAPI clone()
```
    Description copied from class: GrouperAPI
    
    deep clone the fields in this object
    
    Specified by:
    
    clone in interface GrouperCloneable
    
    Specified by:
    
    clone in class GrouperAPI
    
    Returns:
    
    the clone of the object
    
    See Also:
    
    GrouperAPI.clone()
  - getContextId
```
public String getContextId()
```
    Returns:
    
    context id
  - setContextId
```
public void setContextId(String contextId1)
```
    set context id
    
    Parameters:
    
    contextId1 -
  - saveOrUpdate
```
public void saveOrUpdate()
```
    save or update this object
  - delete
```
public void delete()
```
    delete this object
  - getQueueOrTopic
```
public String getQueueOrTopic()
```
    Returns:
    
    queue or topic
  - setQueueOrTopic
```
public void setQueueOrTopic(String theQueueOrTopic1)
```
    Parameters:
    
    theQueueOrTopic1 -

Class GrouperMessageHibernate

Field Summary

Fields inherited from class edu.internet2.middleware.grouper.GrouperAPI

Fields inherited from interface org.hibernate.classic.Lifecycle

Constructor Summary

Method Summary

Methods inherited from class edu.internet2.middleware.grouper.GrouperAPI

Methods inherited from class java.lang.Object

Field Detail

COLUMN_ID

COLUMN_HIBERNATE_VERSION_NUMBER

FIELD_CONTEXT_ID

FIELD_ID

COLUMN_SENT_TIME_MICROS

COLUMN_GET_ATTEMPT_TIME_MILLIS

COLUMN_ATTEMPT_TIME_EXPIRES_MILLIS

COLUMN_GET_ATTEMPT_COUNT

COLUMN_STATE

COLUMN_GET_TIME_MILLIS

COLUMN_FROM_MEMBER_ID

COLUMN_QUEUE_NAME

COLUMN_MESSAGE_BODY

TABLE_GROUPER_MESSAGE

Constructor Detail

GrouperMessageHibernate

Method Detail

getAttemptTimeExpiresMillis

setAttemptTimeExpiresMillis

getState

setState

setId

getFromMemberId

getId

getMessageBody

setFromMemberId

setMessageBody

getSentTimeMicros

setSentTimeMicros

getQueueName

setQueueName

getGetTimeMillis

setGetTimeMillis

getGetAttemptTimeMillis

setGetAttemptTimeMillis

getGetAttemptCount

setGetAttemptCount

clone

getContextId

setContextId

saveOrUpdate

delete

getQueueOrTopic

setQueueOrTopic