com.microsoft.azure.management.network.ApplicationGatewayListener Maven / Gradle / Ivy
Show all versions of azure-mgmt-network Show documentation
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*/
package com.microsoft.azure.management.network;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.network.model.HasHostName;
import com.microsoft.azure.management.network.model.HasProtocol;
import com.microsoft.azure.management.network.model.HasPublicIPAddress;
import com.microsoft.azure.management.network.model.HasServerNameIndication;
import com.microsoft.azure.management.network.model.HasSslCertificate;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ChildResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasSubnet;
import com.microsoft.azure.management.resources.fluentcore.model.Attachable;
import com.microsoft.azure.management.resources.fluentcore.model.Settable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
/**
* A client-side representation of an application gateway's HTTP listener.
*/
@Fluent()
public interface ApplicationGatewayListener extends
HasInner,
ChildResource,
HasSslCertificate,
HasPublicIPAddress,
HasProtocol,
HasHostName,
HasServerNameIndication,
HasSubnet {
/**
* @return the frontend IP configuration this listener is associated with.
*/
ApplicationGatewayFrontend frontend();
/**
* @return the number of the frontend port the listener is listening on
*/
int frontendPortNumber();
/**
* @return the name of the frontend port the listener is listening on
*/
String frontendPortName();
/**
* Grouping of application gateway HTTP listener configuration stages.
*/
interface DefinitionStages {
/**
* The first stage of an application gateway HTTP listener.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface Blank extends WithFrontend {
}
/**
* The final stage of an application gateway HTTP listener.
*
* At this stage, any remaining optional settings can be specified, or the definition
* can be attached to the parent application gateway definition.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithAttach extends
Attachable.InDefinition,
WithProtocol,
WithHostName,
WithServerNameIndication {
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the frontend IP configuration to associate the listener with.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithFrontend {
/**
* Associates the listener with the application gateway's private (internal) frontend.
*
* If the private frontend does not exist yet, it will be created under an auto-generated name
* and associated with the application gateway's subnet.
* @return the next stage of the definition
*/
WithFrontendPort withPrivateFrontend();
/**
* Associates the listener with the application gateway's public (Internet-facing) frontend.
*
* If the public frontend does not exist yet, it will be created under an auto-generated name
* and associated with the application gateway's public IP address.
* @return the next stage of the definition
*/
WithFrontendPort withPublicFrontend();
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the frontend port to associate the listener with.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithFrontendPort {
/**
* Enables the listener to listen on the specified existing frontend port.
* @param name the name of an existing frontend port
* @return the next stage of the definition
*/
WithAttach withFrontendPort(String name);
/**
* Enables the listener to listen on the specified frontend port number.
* If a frontend port for this port number does not yet exist, a new will be created with an auto-generated name.
* @param portNumber a port number
* @return the next stage of the definition
*/
WithAttach withFrontendPort(int portNumber);
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the SSL certificate to associate with the listener.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithSslCertificate extends HasSslCertificate.DefinitionStages.WithSslCertificate> {
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the password for the private key of the imported SSL certificate.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithSslPassword extends HasSslCertificate.DefinitionStages.WithSslPassword> {
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the protocol.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithProtocol {
/**
* Specifies that the listener is for the HTTP protocol.
* @return the next stage of the definition
*/
@Method
WithAttach withHttp();
/**
* Specifies that the listener is for the HTTPS protocol.
* @return the next stage of the definition
*/
@Method
WithSslCertificate withHttps();
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the hostname of the website for which the
* traffic is received.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithHostName extends HasHostName.DefinitionStages.WithHostName> {
}
/**
* The stage of an application gateway frontend listener definition allowing to require server name indication (SNI).
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithServerNameIndication extends HasServerNameIndication.DefinitionStages.WithServerNameIndication> {
}
}
/** The entirety of an application gateway HTTP listener definition.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface Definition extends
DefinitionStages.Blank,
DefinitionStages.WithAttach,
DefinitionStages.WithFrontend,
DefinitionStages.WithFrontendPort,
DefinitionStages.WithSslCertificate,
DefinitionStages.WithSslPassword,
DefinitionStages.WithHostName {
}
/**
* Grouping of application gateway HTTP listener update stages.
*/
interface UpdateStages {
/**
* The stage of an application gateway frontend listener update allowing to specify the frontend IP configuration to associate the listener with.
*/
interface WithFrontend {
/**
* Associates the listener with the application gateway's private (internal) frontend.
*
* If the private frontend does not exist yet, it will be created under an auto-generated name
* and associated with the application gateway's subnet.
* @return the next stage of the update
*/
Update withPrivateFrontend();
/**
* Associates the listener with the application gateway's public (Internet-facing) frontend.
*
* If the public frontend does not exist yet, it will be created under an auto-generated name
* and associated with the application gateway's public IP address.
* @return the next stage of the update
*/
Update withPublicFrontend();
}
/**
* The stage of an application gateway frontend listener update allowing to specify the frontend port to associate the listener with.
*/
interface WithFrontendPort {
/**
* Enables the listener to listen on the specified existing frontend port.
* @param name the name of an existing frontend port
* @return the next stage of the definition
*/
Update withFrontendPort(String name);
/**
* Enables the listener to listen on the specified frontend port number.
*
* If a frontend port for this port number does not yet exist, a new will be created with an auto-generated name.
* @param portNumber a port number
* @return the next stage of the definition
*/
Update withFrontendPort(int portNumber);
}
/**
* The stage of an application gateway frontend listener update allowing to specify the SSL certificate to associate with the listener.
*/
interface WithSslCertificate extends HasSslCertificate.UpdateStages.WithSslCertificate {
}
/**
* The stage of an application gateway frontend listener update allowing to specify the password for the private key of the imported SSL certificate.
*/
interface WithSslPassword extends HasSslCertificate.UpdateStages.WithSslPassword {
}
/**
* The stage of an application gateway frontend listener update allowing to specify the protocol.
*/
interface WithProtocol {
/**
* Specifies that the listener is for the HTTP protocol.
* @return the next stage of the update
*/
@Method
Update withHttp();
/**
* Specifies that the listener is for the HTTPS protocol.
* @return the next stage of the update
*/
@Method
WithSslCertificate withHttps();
}
/**
* The stage of an application gateway frontend listener update allowing to require server name indication (SNI).
*/
interface WithServerNameIndication extends HasServerNameIndication.UpdateStages.WithServerNameIndication {
}
/**
* The stage of an application gateway frontend listener update allowing to specify the hostname of the website for which the
* traffic is received.
*/
interface WithHostName extends HasHostName.UpdateStages.WithHostName {
}
}
/**
* The entirety of an application gateway HTTP listener update as part of an application gateway update.
*/
interface Update extends
Settable,
UpdateStages.WithServerNameIndication,
UpdateStages.WithHostName,
UpdateStages.WithProtocol,
UpdateStages.WithSslCertificate,
UpdateStages.WithSslPassword,
UpdateStages.WithFrontendPort,
UpdateStages.WithFrontend {
}
/**
* Grouping of application gateway HTTP listener definition stages applicable as part of an application gateway update.
*/
interface UpdateDefinitionStages {
/**
* The first stage of an application gateway HTTP listener configuration definition.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface Blank extends WithFrontend {
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the frontend IP configuration to associate the listener with.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithFrontend {
/**
* Associates the listener with the application gateway's private (internal) frontend.
*
* If the private frontend does not exist yet, it will be created under an auto-generated name
* and associated with the application gateway's subnet.
* @return the next stage of the definition
*/
WithFrontendPort withPrivateFrontend();
/**
* Associates the listener with the application gateway's public (Internet-facing) frontend.
*
* If the public frontend does not exist yet, it will be created under an auto-generated name
* and associated with the application gateway's public IP address.
* @return the next stage of the definition
*/
WithFrontendPort withPublicFrontend();
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the frontend port to associate the listener with.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithFrontendPort {
/**
* Enables the listener to listen on the specified existing frontend port.
* @param name the name of an existing frontend port
* @return the next stage of the definition
*/
WithAttach withFrontendPort(String name);
/**
* Enables the listener to listen on the specified frontend port number.
* If a frontend port for this port number does not yet exist, a new will be created with an auto-generated name.
* @param portNumber a port number
* @return the next stage of the definition
*/
WithAttach withFrontendPort(int portNumber);
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the protocol.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithProtocol {
/**
* Specifies that the listener is for the HTTP protocol.
* @return the next stage of the definition
*/
@Method
WithAttach withHttp();
/**
* Specifies that the listener is for the HTTPS protocol.
* @return the next stage of the definition
*/
@Method
WithSslCertificate withHttps();
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the SSL certificate to associate with the listener.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithSslCertificate extends HasSslCertificate.UpdateDefinitionStages.WithSslCertificate> {
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the password for the private key of the imported SSL certificate.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithSslPassword extends HasSslCertificate.UpdateDefinitionStages.WithSslPassword> {
}
/**
* The stage of an application gateway frontend listener definition allowing to specify the hostname of the website for which the
* traffic is received.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithHostName extends HasHostName.UpdateDefinitionStages.WithHostName> {
}
/**
* The stage of an application gateway frontend listener definition allowing to require server name indication (SNI).
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithServerNameIndication extends HasServerNameIndication.UpdateDefinitionStages.WithServerNameIndication> {
}
/** The final stage of an application gateway HTTP listener definition.
*
* At this stage, any remaining optional settings can be specified, or the definition
* can be attached to the parent application gateway definition.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithAttach extends
Attachable.InUpdate,
UpdateDefinitionStages.WithServerNameIndication,
UpdateDefinitionStages.WithHostName,
UpdateDefinitionStages.WithProtocol {
}
}
/** The entirety of an application gateway HTTP listener definition as part of an application gateway update.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface UpdateDefinition extends
UpdateDefinitionStages.Blank,
UpdateDefinitionStages.WithFrontend,
UpdateDefinitionStages.WithFrontendPort,
UpdateDefinitionStages.WithAttach,
UpdateDefinitionStages.WithSslCertificate,
UpdateDefinitionStages.WithSslPassword {
}
}