indexing
	description: "URLs for FTP resources"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
	revision: "$Revision: 56675 $"

class interface
	FTP_URL

create 
	make (a: STRING_8)
			-- Create address.
		require -- from URL
			address_specified: a /= Void and then not a.is_empty
		ensure -- from URL
			address_set: address = a
			port_set: port > 0
			no_proxy_set: proxy_information = Void

feature -- Access

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)

	hash_code: INTEGER_32
			-- Hash function
			-- (from NETWORK_RESOURCE_URL)
		ensure -- from HASHABLE
			good_hash_value: Result >= 0

	host: STRING_8
			-- Name or IP address of host
			-- (from NETWORK_RESOURCE_URL)

	location: STRING_8
			-- Full URL of resource
			-- (from NETWORK_RESOURCE_URL)

	password: STRING_8
			-- Optional password
			-- (from NETWORK_RESOURCE_URL)

	path: STRING_8
			-- Path of resource
			-- (from NETWORK_RESOURCE_URL)

	port: INTEGER_32
			-- Port used by service
			-- (from URL)

	proxy_host: STRING_8
			-- Name or address of proxy host
			-- (from URL)
		require -- from URL
			proxy_supported: is_proxy_supported
			has_proxy: is_proxy_used
		ensure -- from URL
			result_not_empty: Result /= Void and then not Result.is_empty

	proxy_port: INTEGER_32
			-- Port of proxy
			-- (from URL)
		require -- from URL
			proxy_supported: is_proxy_supported
			has_proxy: is_proxy_used
		ensure -- from URL
			result_non_negative: Result >= 0

	service: STRING_8 is "ftp"
			-- Name of service (Answer: "ftp")

	username: STRING_8
			-- Optional username
			-- (from NETWORK_RESOURCE_URL)
	
feature -- Comparison

	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies some.same_type (other)
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	is_equal (other: like Current): BOOLEAN
			-- Is equal to `other'?
			-- (from NETWORK_RESOURCE_URL)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other.is_equal (Current)
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of `other' (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	default_port: INTEGER_32 is 21
			-- Number of default port for service (Answer: 21)

	has_username: BOOLEAN is True
			-- Can address contain a username? (Answer: yes)

	proxy_host_ok (h: STRING_8): BOOLEAN
			-- Is `h' a valid host?
			-- (from HOST_VALIDITY_CHECKER)
		require -- from URL
			proxy_supported: is_proxy_supported

	is_correct: BOOLEAN
			-- Is address correct?
			-- (from NETWORK_RESOURCE_URL)

	is_hashable: BOOLEAN
			-- May current object be hashed?
			-- (True if it is not its type's default.)
			-- (from HASHABLE)
		ensure -- from HASHABLE
			ok_if_not_default: Result implies (Current /= default)

	is_host_correct (h: STRING_8): BOOLEAN
			-- Is host `h' name correct?
			-- (from NETWORK_RESOURCE_URL)

	is_password_accepted: BOOLEAN
			-- Can a password be set?
			-- (from NETWORK_RESOURCE_URL)

	is_path_correct (p: STRING_8): BOOLEAN
			-- Is path name correct?

	is_proxy_supported: BOOLEAN is True
			-- Are proxy connections supported? (Answer: yes)

	is_proxy_used: BOOLEAN
			-- Is a proxy used?
			-- (from URL)

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of `other'?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
	
feature -- Status setting

	reset_proxy
			-- Reset proxy information.
			-- (from URL)
		require -- from URL
			proxy_supported: is_proxy_supported
		ensure -- from URL
			no_proxy_set: not is_proxy_used
			port_reset: proxy_port = 0

	set_password (pw: STRING_8)
			-- Set password.
			-- (from NETWORK_RESOURCE_URL)
		require -- from URL
			password_accepted: is_password_accepted
			non_empty_password: pw /= Void and then not pw.is_empty
		ensure then -- from NETWORK_RESOURCE_URL
			password_set: password = pw

	set_port (port_no: INTEGER_32)
			-- Set port to `port_no'.
			-- (from URL)
		require -- from URL
			port_non_negative: port_no >= 0
		ensure -- from URL
			port_set: port = port_no

	set_proxy (host: STRING_8; port_no: INTEGER_32)
			-- Set proxy host to host and proxy port to `port_no'.
			-- (from URL)
		require -- from URL
			proxy_supported: is_proxy_supported
			non_empty_host: host /= Void and then not host.is_empty
			host_valid: proxy_host_ok (host)
			non_negative_port: port_no >= 0
		ensure -- from URL
			host_set: proxy_host = host
			port_set: proxy_port = port_no

	set_proxy_information (pi: PROXY_INFORMATION)
			-- Set proxy information to `pi'.
			-- (from URL)
		require -- from URL
			proxy_supported: is_proxy_supported
		ensure -- from URL
			proxy_information_set: proxy_information = pi

	set_username (un: STRING_8)
			-- Set username.
			-- (from NETWORK_RESOURCE_URL)
		require -- from URL
			username_ok: has_username
			non_empty_username: un /= Void and then not un.is_empty
		ensure then -- from NETWORK_RESOURCE_URL
			username_set: username = un
	
feature -- Duplication

	copy (other: like Current)
			-- Update current object using fields of object attached
			-- to `other', so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)

	frozen deep_copy (other: like Current)
			-- Effect equivalent to that of:
			--		copy (`other' . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: like Current
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: like Current)
			-- Copy every field of `other' onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: like Current
			-- New object field-by-field identical to `other'.
			-- Always uses default copying semantics.
			-- (from ANY)
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)

	frozen twin: like Current
			-- New object equal to `Current'
			-- twin calls copy; to change copying/twining semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result.is_equal (Current)
	
feature -- Basic operations

	frozen default: like Current
			-- Default value of object's type
			-- (from ANY)

	frozen default_pointer: POINTER
			-- Default value of type `POINTER'
			-- (Avoid the need to write `p'.default for
			-- some `p' of type `POINTER'.)
			-- (from ANY)

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
	
feature -- Output

	io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of tagged_out.
			-- (from ANY)

	print (some: ANY)
			-- Write terse external representation of `some'
			-- on standard output.
			-- (from ANY)

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of out.
			-- (from ANY)
	
feature -- Platform

	operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
	
invariant
		-- from NETWORK_RESOURCE_URL
	username_exists: username /= Void
	password_exists: password /= Void
	password_constraint: not password.is_empty implies not username.is_empty

		-- from URL
	proxy_used_definition: is_proxy_used = (proxy_information /= Void)
	proxy_usage_constraint: is_proxy_used implies is_proxy_supported

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

indexing
	copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		356 Storke Road, Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class FTP_URL