software.amazon.awssdk.services.cloudfront.model.ResponseHeadersPolicyXSSProtection Maven / Gradle / Ivy
Show all versions of cloudfront Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudfront.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header's value.
*
*
* For more information about the X-XSS-Protection HTTP response header, see X-XSS-Protection in the MDN Web
* Docs.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ResponseHeadersPolicyXSSProtection implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField OVERRIDE_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("Override")
.getter(getter(ResponseHeadersPolicyXSSProtection::override))
.setter(setter(Builder::override))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Override")
.unmarshallLocationName("Override").build()).build();
private static final SdkField PROTECTION_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("Protection")
.getter(getter(ResponseHeadersPolicyXSSProtection::protection))
.setter(setter(Builder::protection))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Protection")
.unmarshallLocationName("Protection").build()).build();
private static final SdkField MODE_BLOCK_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("ModeBlock")
.getter(getter(ResponseHeadersPolicyXSSProtection::modeBlock))
.setter(setter(Builder::modeBlock))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModeBlock")
.unmarshallLocationName("ModeBlock").build()).build();
private static final SdkField REPORT_URI_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ReportUri")
.getter(getter(ResponseHeadersPolicyXSSProtection::reportUri))
.setter(setter(Builder::reportUri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReportUri")
.unmarshallLocationName("ReportUri").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OVERRIDE_FIELD,
PROTECTION_FIELD, MODE_BLOCK_FIELD, REPORT_URI_FIELD));
private static final long serialVersionUID = 1L;
private final Boolean override;
private final Boolean protection;
private final Boolean modeBlock;
private final String reportUri;
private ResponseHeadersPolicyXSSProtection(BuilderImpl builder) {
this.override = builder.override;
this.protection = builder.protection;
this.modeBlock = builder.modeBlock;
this.reportUri = builder.reportUri;
}
/**
*
* A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header
* received from the origin with the one specified in this response headers policy.
*
*
* @return A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response
* header received from the origin with the one specified in this response headers policy.
*/
public final Boolean override() {
return override;
}
/**
*
* A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this setting
* is true, the value of the X-XSS-Protection header is 1. When this setting
* is false, the value of the X-XSS-Protection header is 0.
*
*
* For more information about these settings, see X-XSS-Protection in the MDN
* Web Docs.
*
*
* @return A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this
* setting is true, the value of the X-XSS-Protection header is 1.
* When this setting is false, the value of the X-XSS-Protection header is
* 0.
*
* For more information about these settings, see X-XSS-Protection in
* the MDN Web Docs.
*/
public final Boolean protection() {
return protection;
}
/**
*
* A Boolean that determines whether CloudFront includes the mode=block directive in the
* X-XSS-Protection header.
*
*
* For more information about this directive, see X-XSS-Protection in the MDN
* Web Docs.
*
*
* @return A Boolean that determines whether CloudFront includes the mode=block directive in the
* X-XSS-Protection header.
*
* For more information about this directive, see X-XSS-Protection in
* the MDN Web Docs.
*/
public final Boolean modeBlock() {
return modeBlock;
}
/**
*
* A reporting URI, which CloudFront uses as the value of the report directive in the
* X-XSS-Protection header.
*
*
* You cannot specify a ReportUri when ModeBlock is true.
*
*
* For more information about using a reporting URL, see X-XSS-Protection in the MDN
* Web Docs.
*
*
* @return A reporting URI, which CloudFront uses as the value of the report directive in the
* X-XSS-Protection header.
*
* You cannot specify a ReportUri when ModeBlock is true.
*
*
* For more information about using a reporting URL, see X-XSS-Protection in
* the MDN Web Docs.
*/
public final String reportUri() {
return reportUri;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(override());
hashCode = 31 * hashCode + Objects.hashCode(protection());
hashCode = 31 * hashCode + Objects.hashCode(modeBlock());
hashCode = 31 * hashCode + Objects.hashCode(reportUri());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ResponseHeadersPolicyXSSProtection)) {
return false;
}
ResponseHeadersPolicyXSSProtection other = (ResponseHeadersPolicyXSSProtection) obj;
return Objects.equals(override(), other.override()) && Objects.equals(protection(), other.protection())
&& Objects.equals(modeBlock(), other.modeBlock()) && Objects.equals(reportUri(), other.reportUri());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("ResponseHeadersPolicyXSSProtection").add("Override", override()).add("Protection", protection())
.add("ModeBlock", modeBlock()).add("ReportUri", reportUri()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Override":
return Optional.ofNullable(clazz.cast(override()));
case "Protection":
return Optional.ofNullable(clazz.cast(protection()));
case "ModeBlock":
return Optional.ofNullable(clazz.cast(modeBlock()));
case "ReportUri":
return Optional.ofNullable(clazz.cast(reportUri()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ResponseHeadersPolicyXSSProtection) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response header
* received from the origin with the one specified in this response headers policy.
*
*
* @param override
* A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP response
* header received from the origin with the one specified in this response headers policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder override(Boolean override);
/**
*
* A Boolean that determines the value of the X-XSS-Protection HTTP response header. When this
* setting is true, the value of the X-XSS-Protection header is 1. When
* this setting is false, the value of the X-XSS-Protection header is 0.
*
*
* For more information about these settings, see X-XSS-Protection in the
* MDN Web Docs.
*
*
* @param protection
* A Boolean that determines the value of the X-XSS-Protection HTTP response header. When
* this setting is true, the value of the X-XSS-Protection header is
* 1. When this setting is false, the value of the
* X-XSS-Protection header is 0.
*
* For more information about these settings, see X-XSS-Protection
* in the MDN Web Docs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder protection(Boolean protection);
/**
*
* A Boolean that determines whether CloudFront includes the mode=block directive in the
* X-XSS-Protection header.
*
*
* For more information about this directive, see X-XSS-Protection in the
* MDN Web Docs.
*
*
* @param modeBlock
* A Boolean that determines whether CloudFront includes the mode=block directive in the
* X-XSS-Protection header.
*
* For more information about this directive, see X-XSS-Protection
* in the MDN Web Docs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modeBlock(Boolean modeBlock);
/**
*
* A reporting URI, which CloudFront uses as the value of the report directive in the
* X-XSS-Protection header.
*
*
* You cannot specify a ReportUri when ModeBlock is true.
*
*
* For more information about using a reporting URL, see X-XSS-Protection in the
* MDN Web Docs.
*
*
* @param reportUri
* A reporting URI, which CloudFront uses as the value of the report directive in the
* X-XSS-Protection header.
*
* You cannot specify a ReportUri when ModeBlock is true.
*
*
* For more information about using a reporting URL, see X-XSS-Protection
* in the MDN Web Docs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reportUri(String reportUri);
}
static final class BuilderImpl implements Builder {
private Boolean override;
private Boolean protection;
private Boolean modeBlock;
private String reportUri;
private BuilderImpl() {
}
private BuilderImpl(ResponseHeadersPolicyXSSProtection model) {
override(model.override);
protection(model.protection);
modeBlock(model.modeBlock);
reportUri(model.reportUri);
}
public final Boolean getOverride() {
return override;
}
public final void setOverride(Boolean override) {
this.override = override;
}
@Override
public final Builder override(Boolean override) {
this.override = override;
return this;
}
public final Boolean getProtection() {
return protection;
}
public final void setProtection(Boolean protection) {
this.protection = protection;
}
@Override
public final Builder protection(Boolean protection) {
this.protection = protection;
return this;
}
public final Boolean getModeBlock() {
return modeBlock;
}
public final void setModeBlock(Boolean modeBlock) {
this.modeBlock = modeBlock;
}
@Override
public final Builder modeBlock(Boolean modeBlock) {
this.modeBlock = modeBlock;
return this;
}
public final String getReportUri() {
return reportUri;
}
public final void setReportUri(String reportUri) {
this.reportUri = reportUri;
}
@Override
public final Builder reportUri(String reportUri) {
this.reportUri = reportUri;
return this;
}
@Override
public ResponseHeadersPolicyXSSProtection build() {
return new ResponseHeadersPolicyXSSProtection(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}