Proxy Class

Summary

Contains HTTP proxy settings used to process requests to Internet resources.
Assembly
NAnt.Core.dll
Namespace
NAnt.Core.Types
Interfaces
Base Types
graph BT Type-->Base0["DataTypeBase"] click Base0 "/api/NAnt.Core/DataTypeBase" Base0-->Base1["Element"] click Base1 "/api/NAnt.Core/Element" Base1-->Base2["Object"] Type-.->Interface0["IConditional"] click Interface0 "/api/NAnt.Core/IConditional" Type["Proxy"] class Type type-node

Syntax

[ElementName("proxy")]
public class Proxy : DataTypeBase, IConditional

Attributes

Type Description
ElementNameAttribute Indicates that class should be treated as a NAnt element.

Constructors

Name Summary
Proxy() Initializes a new instance of the NAnt.Core.Types.Proxy class.

Properties

Name Value Summary
BypassOnLocal bool
Specifies whether to bypass the proxy server for local addresses. The default is false.
CanBeReferenced bool
Gets a value indicating whether a reference to the type can be defined.
Inherited from DataTypeBase
Credentials Credential
The credentials to submit to the proxy server for authentication.
CustomXmlProcessing bool
Gets a value indicating whether the element is performing additional processing using the NAnt.Core.Element.XmlNode that was used to initialize the element.
Inherited from Element
Host string
The name of the proxy host.
ID string
The ID used to be referenced later.
Inherited from DataTypeBase
IfDefined bool
Indicates if the proxy should be used to connect to the external resource. If true then the proxy will be used; otherwise, not. The default is true.
Location Location
Gets or sets the location in the build file where the element is defined.
Inherited from Element
Name string
Gets the name of the data type.
Inherited from DataTypeBase
NamespaceManager XmlNamespaceManager
Gets or sets the System.Xml.XmlNamespaceManager.
Inherited from Element
Parent Object
Gets or sets the parent of the element.
Inherited from Element
Port int
The port number on NAnt.Core.Types.Proxy.Host to use.
Project Project
Gets or sets the NAnt.Core.Element.Project to which this element belongs.
Inherited from Element
Properties PropertyDictionary
Gets the properties local to this NAnt.Core.Element and the NAnt.Core.Element.Project.
Inherited from Element
RefID string
The ID to use as the reference.
Inherited from DataTypeBase
UnlessDefined bool
Indicates if the proxy should not be used to connect to the external resource. If false then the proxy will be used; otherwise, not. The default is false.
XmlNode XmlNode
Gets or sets the XML node of the element.
Inherited from Element

Methods

Name Value Summary
CopyTo(DataTypeBase) void
Copies all instance data of the NAnt.Core.DataTypeBase to a given NAnt.Core.DataTypeBase.
Inherited from DataTypeBase
CopyTo(Element) void
Copies all instance data of the NAnt.Core.Element to a given NAnt.Core.Element.
Inherited from Element
GetAttributeConfigurationNode(FrameworkInfo, string) XmlNode
Locates the XML node for the specified attribute in the project configuration node.
Inherited from Element
GetAttributeConfigurationNode(XmlNode, FrameworkInfo, string) XmlNode
Inherited from Element
GetLocation() Location
Retrieves the location in the build file where the element is defined.
Inherited from Element
GetWebProxy() IWebProxy
Gets a System.Net.WebProxy instance representing the current NAnt.Core.Types.Proxy.
Initialize() void
Derived classes should override to this method to provide extra initialization and validation not covered by the base class.
Inherited from DataTypeBase
Initialize(XmlNode) void
Performs default initialization.
Inherited from Element
InitializeBuildElement(Element, XmlNode, Element, Type) Element
Initializes the build element.
Inherited from Element
static
InitializeElement(XmlNode) void
Derived classes should override to this method to provide extra initialization and validation not covered by the base class.
Inherited from Element
InitializeXml(XmlNode, PropertyDictionary, FrameworkInfo) void
Initializes all build attributes and child elements.
Inherited from Element
Log(Level, string) void
Logs a message with the given priority.
Inherited from Element
Log(Level, string, Object[]) void
Logs a message with the given priority.
Inherited from Element
Reset() void
Should be overridden by derived classes. clones the referenced types data into the current instance.
Inherited from DataTypeBase