MetaLease (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.data.DataStructureImpl
- - net.i2p.data.Lease
  - - net.i2p.data.MetaLease

All Implemented Interfaces:
Serializable, DataStructure
```
public class MetaLease
extends Lease
```
Implementation of MetaLease as specified in Proposal 123: New NetDb Entries.
MetaLease extends the Lease concept to reference other LeaseSets rather than tunnel endpoints:
- Points to another LeaseSet via its hash instead of a gateway router
- Enables advanced routing and load balancing strategies
- Includes cost and type information for selection algorithms
- Fixed length of 40 bytes for consistency with Lease2
Structure:
- LeaseSet Hash: 32-byte hash of the target LeaseSet (available via Lease.getGateway())
- Cost: 4-byte cost value for routing decisions
- Type: 4-byte type identifier for the referenced LeaseSet
Key Differences from Lease:
- Reference: Points to LeaseSet hash, not gateway router
- TunnelId: Not supported (throws UnsupportedOperationException)
- Metadata: Includes cost and type for intelligent selection
- Usage: Used within MetaLeaseSet for indirect routing
Usage Scenarios:
- Load Balancing: Distribute traffic across multiple LeaseSets
- Geographic Routing: Select LeaseSets based on location or performance
- Fallback Strategies: Provide alternative LeaseSets for redundancy
- Service Aggregation: Combine multiple services under one destination
Selection Criteria:
- Cost: Lower values indicate preferred routes
- Type: Application-specific categorization
- Hash: Uniquely identifies the target LeaseSet
Implementation Status: PRELIMINARY - Subject to change as proposal evolves
See Also:
Serialized Form

Field Summary
Fields
Modifier and Type Field and Description
static int LENGTH
MetaLease length in bytes.
- Fields inherited from class net.i2p.data.Lease
  _end, _gateway, _tunnelId

Fields
Modifier and Type	Field and Description
`static int`	`LENGTH` MetaLease length in bytes.

Constructor Summary
Constructors
Constructor and Description
MetaLease()

Constructors
Constructor and Description
`MetaLease()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)` Compares this Lease with another object for equality.
`int`	`getCost()` Cost value for this lease.
`TunnelId`	`getTunnelId()` UnsupportedOperationException always.
`int`	`getType()` Type identifier for this lease.
`int`	`hashCode()` Hash code based on end time, gateway, and tunnel ID.
`void`	`readBytes(InputStream in)` Reads the lease from an input stream.
`void`	`setCost(int cost)` Set the cost of this lease.
`void`	`setTunnelId(TunnelId id)` UnsupportedOperationException always.
`void`	`setType(int type)` Set the type of this lease.
`String`	`toString()` Returns a string representation of this Lease.
`void`	`writeBytes(OutputStream out)` Writes the lease to an output stream.

Methods inherited from class net.i2p.data.Lease
getEndDate, getEndTime, getGateway, isExpired, isExpired, setEndDate, setEndDate, setGateway

Methods inherited from class net.i2p.data.DataStructureImpl
calculateHash, fromBase64, fromByteArray, read, toBase64, toByteArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LENGTH
```
public static final int LENGTH
```
    MetaLease length in bytes.
    See Also:
    Constant Field Values
- Constructor Detail
  - MetaLease
```
public MetaLease()
```
- Method Detail
  - equals
```
public boolean equals(Object object)
```
    Compares this Lease with another object for equality.
    Overrides:
    equals in class Lease
  - getCost
```
public int getCost()
```
    Cost value for this lease.
    Returns:
    the cost
  - getTunnelId
```
public TunnelId getTunnelId()
```
    UnsupportedOperationException always.
    Overrides:
    getTunnelId in class Lease
    Returns:
    the tunnel id
    Throws:
    UnsupportedOperationException - always
  - getType
```
public int getType()
```
    Type identifier for this lease.
    Returns:
    the type
  - hashCode
```
public int hashCode()
```
    Hash code based on end time, gateway, and tunnel ID.
    Overrides:
    hashCode in class Lease
  - readBytes
```
public void readBytes(InputStream in)
               throws DataFormatException,
                      IOException
```
    Reads the lease from an input stream.
    Specified by:
    readBytes in interface DataStructure
    Overrides:
    readBytes in class Lease
    Parameters:
    in - stream to read from
    Throws:
    DataFormatException - if the data is improperly formatted
    IOException - if there was a problem reading the stream
  - setCost
```
public void setCost(int cost)
```
    Set the cost of this lease.
    Parameters:
    cost - the cost value
  - setTunnelId
```
public void setTunnelId(TunnelId id)
```
    UnsupportedOperationException always.
    Overrides:
    setTunnelId in class Lease
    Parameters:
    id - tunnel ID
    Throws:
    UnsupportedOperationException - always
  - setType
```
public void setType(int type)
```
    Set the type of this lease.
    Parameters:
    type - the type
  - toString
```
public String toString()
```
    Returns a string representation of this Lease.
    Overrides:
    toString in class Lease
  - writeBytes
```
public void writeBytes(OutputStream out)
                throws DataFormatException,
                       IOException
```
    Writes the lease to an output stream.
    Specified by:
    writeBytes in interface DataStructure
    Overrides:
    writeBytes in class Lease
    Parameters:
    out - stream to write to
    Throws:
    DataFormatException - if the data was incomplete or not yet ready to be written
    IOException - if there was a problem writing to the stream

Class MetaLease

Field Summary

Fields inherited from class net.i2p.data.Lease

Constructor Summary

Method Summary

Methods inherited from class net.i2p.data.Lease

Methods inherited from class net.i2p.data.DataStructureImpl

Methods inherited from class java.lang.Object

Field Detail

LENGTH

Constructor Detail

MetaLease

Method Detail

equals

getCost

getTunnelId

getType

hashCode

readBytes

setCost

setTunnelId

setType

toString

writeBytes