GarlicConfig (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.message.GarlicConfig

Direct Known Subclasses:
PayloadGarlicConfig
```
class GarlicConfig
extends Object
```
Configuration and content for a garlic message containing one or more cloves. This is the top-level container for a GarlicMessage's cloves, their delivery instructions, and the recipient's encryption key. Individual clove payloads are represented by PayloadGarlicConfig. Despite the name, instances of this class hold the actual clove references, not just configuration metadata.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`GarlicConfig(Certificate cert, long id, long expiration, DeliveryInstructions di)` Creates a new GarlicConfig
`protected`	`GarlicConfig(List<GarlicConfig> cloveConfigs, Certificate cert, long id, long expiration, DeliveryInstructions di)` Creates a new GarlicConfig with existing clove configs

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClove(GarlicConfig config)` Add a clove to the current message - if any cloves are added, an I2NP message cannot be specified via setPayload.
`void`	`clearCloves()` Clears all clove configs
`Certificate`	`getCertificate()` Certificate for the getRecipient() to pay for their processing
`GarlicConfig`	`getClove(int index)` Returns the clove at the specified index
`int`	`getCloveCount()` Returns the number of clove configs
`DeliveryInstructions`	`getDeliveryInstructions()` Specify how the I2NPMessage in the clove should be handled.
`long`	`getExpiration()` Expiration of the clove, after which it should be dropped
`long`	`getId()` Unique ID of the clove
`RouterInfo`	`getRecipient()` Returns the recipient router
`PublicKey`	`getRecipientPublicKey()` Returns the recipient's public key
`protected String`	`getSubData()` Returns sub-data for toString
`void`	`setRecipient(RouterInfo info)` Router to receive and process this clove - the router that will open the delivery instructions and decide what to do process it locally as an I2NPMessage, forward it as an I2NPMessage to a router, forward it as an I2NPMessage to a Destination, or forward it as an I2NPMessage to a tunnel.
`void`	`setRecipientPublicKey(PublicKey recipientPublicKey)` Public key of the router to receive and process this clove.
`String`	`toString()`

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

- Constructor Detail
  - GarlicConfig
```
public GarlicConfig(Certificate cert,
                    long id,
                    long expiration,
                    DeliveryInstructions di)
```
    Creates a new GarlicConfig
    Parameters:
    cert - the certificate
    id - the unique ID
    expiration - the expiration time
    di - the delivery instructions
  - GarlicConfig
```
protected GarlicConfig(List<GarlicConfig> cloveConfigs,
                       Certificate cert,
                       long id,
                       long expiration,
                       DeliveryInstructions di)
```
    Creates a new GarlicConfig with existing clove configs
    Parameters:
    cloveConfigs - the list of clove configs
    cert - the certificate
    id - the unique ID
    expiration - the expiration time
    di - the delivery instructions
- Method Detail
  - addClove
```
public void addClove(GarlicConfig config)
```
    Add a clove to the current message - if any cloves are added, an I2NP message cannot be specified via setPayload. This means that the resulting GarlicClove represented by this GarlicConfig must be a GarlicMessage itself
    Parameters:
    config - the clove config to add
  - clearCloves
```
public void clearCloves()
```
    Clears all clove configs
  - getCertificate
```
public Certificate getCertificate()
```
    Certificate for the getRecipient() to pay for their processing
    Returns:
    the certificate
  - getClove
```
public GarlicConfig getClove(int index)
```
    Returns the clove at the specified index
    Parameters:
    index - the index
    Returns:
    the clove config
  - getCloveCount
```
public int getCloveCount()
```
    Returns the number of clove configs
    Returns:
    the clove count
  - getDeliveryInstructions
```
public DeliveryInstructions getDeliveryInstructions()
```
    Specify how the I2NPMessage in the clove should be handled.
    Returns:
    the delivery instructions
  - getExpiration
```
public long getExpiration()
```
    Expiration of the clove, after which it should be dropped
    Returns:
    the expiration time
  - getId
```
public long getId()
```
    Unique ID of the clove
    Returns:
    the unique ID
  - getRecipient
```
public RouterInfo getRecipient()
```
    Returns the recipient router
    Returns:
    the recipient or null
  - getRecipientPublicKey
```
public PublicKey getRecipientPublicKey()
```
    Returns the recipient's public key
    Returns:
    the public key or null
  - getSubData
```
protected String getSubData()
```
    Returns sub-data for toString
    Returns:
    sub-data string
  - setRecipient
```
public void setRecipient(RouterInfo info)
```
    Router to receive and process this clove - the router that will open the delivery instructions and decide what to do process it locally as an I2NPMessage, forward it as an I2NPMessage to a router, forward it as an I2NPMessage to a Destination, or forward it as an I2NPMessage to a tunnel. Used only if recipient public key is not set.
    Parameters:
    info - the recipient router info
  - setRecipientPublicKey
```
public void setRecipientPublicKey(PublicKey recipientPublicKey)
```
    Public key of the router to receive and process this clove. This is useful for garlic routed messages encrypted to the router at the end of a tunnel, as their RouterIdentity is not known, but a PublicKey they handle is exposed via the LeaseSet
    Parameters:
    recipientPublicKey - the recipient's public key
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object

Class GarlicConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GarlicConfig

GarlicConfig

Method Detail

addClove

clearCloves

getCertificate

getClove

getCloveCount

getDeliveryInstructions

getExpiration

getId

getRecipient

getRecipientPublicKey

getSubData

setRecipient

setRecipientPublicKey

toString