com.google.api.ads.admanager.axis.v202208

Class SecurityPolicySettings

java.lang.Object

com.google.api.ads.admanager.axis.v202208.SecurityPolicySettings

All Implemented Interfaces:

Serializable

public class SecurityPolicySettings
extends Object
implements Serializable

A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SecurityPolicySettings()
SecurityPolicySettings(SecurityPolicyType securityPolicyType, String tokenAuthenticationKey, Boolean disableServerSideUrlSigning, OriginForwardingType originForwardingType, String originPathPrefix, OriginForwardingType mediaPlaylistOriginForwardingType, String mediaPlaylistOriginPathPrefix)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Boolean	getDisableServerSideUrlSigning() Gets the disableServerSideUrlSigning value for this SecurityPolicySettings.
OriginForwardingType	getMediaPlaylistOriginForwardingType() Gets the mediaPlaylistOriginForwardingType value for this SecurityPolicySettings.
String	getMediaPlaylistOriginPathPrefix() Gets the mediaPlaylistOriginPathPrefix value for this SecurityPolicySettings.
OriginForwardingType	getOriginForwardingType() Gets the originForwardingType value for this SecurityPolicySettings.
String	getOriginPathPrefix() Gets the originPathPrefix value for this SecurityPolicySettings.
SecurityPolicyType	getSecurityPolicyType() Gets the securityPolicyType value for this SecurityPolicySettings.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
String	getTokenAuthenticationKey() Gets the tokenAuthenticationKey value for this SecurityPolicySettings.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setDisableServerSideUrlSigning(Boolean disableServerSideUrlSigning) Sets the disableServerSideUrlSigning value for this SecurityPolicySettings.
void	setMediaPlaylistOriginForwardingType(OriginForwardingType mediaPlaylistOriginForwardingType) Sets the mediaPlaylistOriginForwardingType value for this SecurityPolicySettings.
void	setMediaPlaylistOriginPathPrefix(String mediaPlaylistOriginPathPrefix) Sets the mediaPlaylistOriginPathPrefix value for this SecurityPolicySettings.
void	setOriginForwardingType(OriginForwardingType originForwardingType) Sets the originForwardingType value for this SecurityPolicySettings.
void	setOriginPathPrefix(String originPathPrefix) Sets the originPathPrefix value for this SecurityPolicySettings.
void	setSecurityPolicyType(SecurityPolicyType securityPolicyType) Sets the securityPolicyType value for this SecurityPolicySettings.
void	setTokenAuthenticationKey(String tokenAuthenticationKey) Sets the tokenAuthenticationKey value for this SecurityPolicySettings.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityPolicySettings

public SecurityPolicySettings()

SecurityPolicySettings

public SecurityPolicySettings(SecurityPolicyType securityPolicyType,
                              String tokenAuthenticationKey,
                              Boolean disableServerSideUrlSigning,
                              OriginForwardingType originForwardingType,
                              String originPathPrefix,
                              OriginForwardingType mediaPlaylistOriginForwardingType,
                              String mediaPlaylistOriginPathPrefix)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getSecurityPolicyType

public SecurityPolicyType getSecurityPolicyType()

Gets the securityPolicyType value for this SecurityPolicySettings.

Returns:

securityPolicyType * Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

setSecurityPolicyType

public void setSecurityPolicyType(SecurityPolicyType securityPolicyType)

Sets the securityPolicyType value for this SecurityPolicySettings.

Parameters:

securityPolicyType - * Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

getTokenAuthenticationKey

public String getTokenAuthenticationKey()

Gets the tokenAuthenticationKey value for this SecurityPolicySettings.

Returns:

tokenAuthenticationKey * Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of securityPolicyType is equal to SecurityPolicyType.AKAMAI and will be set to null otherwise.

setTokenAuthenticationKey

public void setTokenAuthenticationKey(String tokenAuthenticationKey)

Sets the tokenAuthenticationKey value for this SecurityPolicySettings.

Parameters:

tokenAuthenticationKey - * Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of securityPolicyType is equal to SecurityPolicyType.AKAMAI and will be set to null otherwise.

getDisableServerSideUrlSigning

public Boolean getDisableServerSideUrlSigning()

Gets the disableServerSideUrlSigning value for this SecurityPolicySettings.

Returns:

disableServerSideUrlSigning * Whether the segment URLs should be signed using the tokenAuthenticationKey on the server. This is only applicable for delivery media locations that have token authentication enabled.

setDisableServerSideUrlSigning

public void setDisableServerSideUrlSigning(Boolean disableServerSideUrlSigning)

Sets the disableServerSideUrlSigning value for this SecurityPolicySettings.

Parameters:

disableServerSideUrlSigning - * Whether the segment URLs should be signed using the tokenAuthenticationKey on the server. This is only applicable for delivery media locations that have token authentication enabled.

getOriginForwardingType

public OriginForwardingType getOriginForwardingType()

Gets the originForwardingType value for this SecurityPolicySettings.

Returns:

originForwardingType * The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to SecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

setOriginForwardingType

public void setOriginForwardingType(OriginForwardingType originForwardingType)

Sets the originForwardingType value for this SecurityPolicySettings.

Parameters:

originForwardingType - * The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to SecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

getOriginPathPrefix

public String getOriginPathPrefix()

Gets the originPathPrefix value for this SecurityPolicySettings.

Returns:

originPathPrefix * The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of originForwardingType set to OriginForwardingType.CONVENTIONAL, and will be set to null otherwise.

setOriginPathPrefix

public void setOriginPathPrefix(String originPathPrefix)

Sets the originPathPrefix value for this SecurityPolicySettings.

Parameters:

originPathPrefix - * The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of originForwardingType set to OriginForwardingType.CONVENTIONAL, and will be set to null otherwise.

getMediaPlaylistOriginForwardingType

public OriginForwardingType getMediaPlaylistOriginForwardingType()

Gets the mediaPlaylistOriginForwardingType value for this SecurityPolicySettings.

Returns:

mediaPlaylistOriginForwardingType * The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a cdnConfigurationType of CdnConfigurationType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to SecurityPolicyType.AKAMAI. Valid options are OriginForwardingType#NONE or OriginForwardingType#ORIGIN_PATH.

This setting can only be used with CDN configurations with a cdnConfigurationType of CdnConfigurationType.LIVE_STREAM_SOURCE_CONTENT.

setMediaPlaylistOriginForwardingType

public void setMediaPlaylistOriginForwardingType(OriginForwardingType mediaPlaylistOriginForwardingType)

Sets the mediaPlaylistOriginForwardingType value for this SecurityPolicySettings.

Parameters:

mediaPlaylistOriginForwardingType - * The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a cdnConfigurationType of CdnConfigurationType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to SecurityPolicyType.AKAMAI. Valid options are OriginForwardingType#NONE or OriginForwardingType#ORIGIN_PATH.

This setting can only be used with CDN configurations with a cdnConfigurationType of CdnConfigurationType.LIVE_STREAM_SOURCE_CONTENT.

getMediaPlaylistOriginPathPrefix

public String getMediaPlaylistOriginPathPrefix()

Gets the mediaPlaylistOriginPathPrefix value for this SecurityPolicySettings.

Returns:

mediaPlaylistOriginPathPrefix * The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to OriginForwardingType.CONVENTIONAL, and will be set to null otherwise.

setMediaPlaylistOriginPathPrefix

public void setMediaPlaylistOriginPathPrefix(String mediaPlaylistOriginPathPrefix)

Sets the mediaPlaylistOriginPathPrefix value for this SecurityPolicySettings.

Parameters:

mediaPlaylistOriginPathPrefix - * The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to OriginForwardingType.CONVENTIONAL, and will be set to null otherwise.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer