Interface SubscriptionAuthorizerInput
-
- All Superinterfaces:
ClientBasedInput
@DoNotImplement public interface SubscriptionAuthorizerInput extends ClientBasedInput
This is the input parameter of anySubscriptionAuthorizer
providing unmodifiable information about theSubscription
andClientBasedInput
.- Since:
- 4.0.0, CE 2019.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Immutable @NotNull Subscription
getSubscription()
Get the unmodifiable subscription that has to be authorized.@NotNull Optional<Integer>
getSubscriptionIdentifier()
If this property is present, it contains the subscription identifier for the SUBSCRIBE packet.@NotNull UserProperties
getUserProperties()
The user properties from the SUBSCRIBE packet.-
Methods inherited from interface com.hivemq.extension.sdk.api.parameter.ClientBasedInput
getClientInformation, getConnectionInformation
-
-
-
-
Method Detail
-
getUserProperties
@NotNull UserProperties getUserProperties()
The user properties from the SUBSCRIBE packet.For an MQTT 3 client this MQTT 5 property will always contain an empty list as the user properties.
- Returns:
- The
UserProperties
of the SUBSCRIBE packet. - Since:
- 4.0.0, CE 2019.1
-
getSubscriptionIdentifier
@NotNull Optional<Integer> getSubscriptionIdentifier()
If this property is present, it contains the subscription identifier for the SUBSCRIBE packet.For an MQTT 3 client this
Optional
for the MQTT 5 property will always be empty.- Returns:
- An
Optional
containing the subscription identifier of the SUBSCRIBE packet if present. - Since:
- 4.0.0, CE 2019.1
-
getSubscription
@Immutable @NotNull @Immutable @NotNull Subscription getSubscription()
Get the unmodifiable subscription that has to be authorized.- Returns:
- The
Subscription
for this authorization call. - Since:
- 4.0.0, CE 2019.1
-
-