com.latencybusters.lbm
Class UMEStoreEntry

java.lang.Object
  extended by com.latencybusters.lbm.UMEStoreEntry

public class UMEStoreEntry
extends java.lang.Object

UME Store Entry class. Holds information about a source's registration with a UME store, including the store's domain ID, IP address and port, group index, and the source's current registration ID.

Since:
UME 2.0

Constructor Summary
UMEStoreEntry()
          Creates a UMEStoreEntry object and initializes all values to 0.
UMEStoreEntry(java.net.InetSocketAddress address, int groupIndex, long registrationId)
          Creates a UMEStoreEntry object and uses supplied values for initialization.
UMEStoreEntry(java.net.InetSocketAddress address, int groupIndex, long registrationId, long domainId)
          Creates a UMEStoreEntry object and uses supplied values for initialization.
UMEStoreEntry(java.net.InetSocketAddress address, int groupIndex, long registrationId, long domainId, java.lang.String name)
          Creates a UMEStoreEntry object and uses supplied values for initialization.
 
Method Summary
 java.net.InetSocketAddress address()
          Accessor function to get the store's address.
 long domainId()
          Accessor function to return the store's domain ID
 int groupIndex()
          Accessor function to get the store's group index.
 boolean isNamed()
          Function to determine if the store has a name.
 java.lang.String name()
          Accessor function to return the store's name.
 long registrationId()
          Accessor function to return the source's registration ID with this store.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UMEStoreEntry

public UMEStoreEntry()
Creates a UMEStoreEntry object and initializes all values to 0.

Since:
UME 2.0

UMEStoreEntry

public UMEStoreEntry(java.net.InetSocketAddress address,
                     int groupIndex,
                     long registrationId)
              throws LBMEInvalException
Creates a UMEStoreEntry object and uses supplied values for initialization. The domain ID is set to 0.

Parameters:
address - The address (IP and port) of the store.
groupIndex - The group the store belongs to (must be >= 0).
registrationId - The source's registration ID (must be >= 0).
Throws:
LBMEInvalException - if groupIndex or registrationId are < 0.
Since:
UME 2.0

UMEStoreEntry

public UMEStoreEntry(java.net.InetSocketAddress address,
                     int groupIndex,
                     long registrationId,
                     long domainId)
              throws LBMEInvalException
Creates a UMEStoreEntry object and uses supplied values for initialization.

Parameters:
address - The address (IP and port) of the store.
groupIndex - The group the store belongs to (must be >= 0).
registrationId - The source's registration ID (must be >= 0).
domainId - The store's domain ID (must be >= 0).
Throws:
LBMEInvalException - if groupIndex, registrationId, or domainId are < 0.
Since:
UME 6.0

UMEStoreEntry

public UMEStoreEntry(java.net.InetSocketAddress address,
                     int groupIndex,
                     long registrationId,
                     long domainId,
                     java.lang.String name)
              throws LBMEInvalException
Creates a UMEStoreEntry object and uses supplied values for initialization.

Parameters:
address - The address (IP and port) of the store.
groupIndex - The group the store belongs to (must be >= 0).
registrationId - The source's registration ID (must be >= 0).
domainId - The store's domain ID (must be >= 0).
name - The name of the store if available.
Throws:
LBMEInvalException - if groupIndex, registrationId, or domainId are < 0.
Since:
UME 6.7
Method Detail

address

public java.net.InetSocketAddress address()
Accessor function to get the store's address.

Returns:
The store's address (IP and port).
Since:
UME 2.0

groupIndex

public int groupIndex()
Accessor function to get the store's group index.

Returns:
The store's group index.
Since:
UME 2.0

registrationId

public long registrationId()
Accessor function to return the source's registration ID with this store.

Returns:
The source's registration ID.
Since:
UME 2.0

domainId

public long domainId()
Accessor function to return the store's domain ID

Returns:
The store's domain ID.
Since:
UME 6.0

isNamed

public boolean isNamed()
Function to determine if the store has a name.

Returns:
True if this entry refers to a named store, false otherwise
Since:
UME 6.7

name

public java.lang.String name()
Accessor function to return the store's name.

Returns:
The store name if set, null otherwise.
Since:
UME 6.7


\ All of the documentation and software included in this and any \ other Informatica Inc "Ultra Messaging" Release is \ Copyright (C) 2004-2014, Informatica Corporation. All rights reserved. \ Redistribution and use in source and binary forms, with or without \ modification, are permitted only as covered by the terms of a \ valid software license agreement with 29West Inc. \ Copyright © 2004-2014, Informatica, Inc. All Rights Reserved. \