Share via


IServiceProxyAdministration Interface

Administrative support for creating and connecting proxies to remote service applications.

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public Interface IServiceProxyAdministration
'Usage
Dim instance As IServiceProxyAdministration
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public interface IServiceProxyAdministration

Remarks

In this example, SampleWebServiceProxy inherits from SPIisWebServiceProxy and implements the IServiceProxyAdministration interface.

    using Microsoft.SharePoint.Administration;

    [Guid("470DC8EA-77FB-4623-87F7-3237E2B21B02")]
    [SupportedServiceApplication("1D14CB15-2DB1-4395-B187-70355C829630", "1.0.0.0", typeof(SampleWebServiceApplicationProxy))]
    internal sealed class SampleWebServiceProxy : SPIisWebServiceProxy, IServiceProxyAdministration
    {
    Imports Microsoft.SharePoint.Administration

    <Guid("470DC8EA-77FB-4623-87F7-3237E2B21B02"), SupportedServiceApplication("1D14CB15-2DB1-4395-B187-70355C829630", "1.0.0.0", GetType(SampleWebServiceApplicationProxy))> _
    Friend NotInheritable Class SampleWebServiceProxy
        Inherits SPIisWebServiceProxy
        Implements IServiceProxyAdministration

Implement IServiceProxyAdministration to support connections to service applications in remote farms using the "Connect" button on the ribbon on the Service Application Management page.

IServiceProxyAdministration requires the GetProxyTypes, GetProxyDescription and CreateProxy methods to be implemented.

        #region IServiceProxyAdministration Members
        public Type[] GetProxyTypes()
        {
            return new Type[] { typeof(SampleWebServiceApplicationProxy) };
        }
        public SPPersistedTypeDescription GetProxyTypeDescription(
            Type serviceApplicationProxyType)
        {
            return new SPPersistedTypeDescription(
                "Sample Web Service Proxy",
                "Connects to the Sample Web Service.");
        }
        public SPServiceApplicationProxy CreateProxy(
            Type serviceApplicationProxyType,
            string name,
            Uri serviceApplicationUri,
            SPServiceProvisioningContext provisioningContext)
        {
            // Create a proxy for the specified (typically remote) service application
            return new SampleWebServiceApplicationProxy(
                name,
                this,
                serviceApplicationUri);
        }
        #endregion
                #Region "IServiceProxyAdministration Members"
                Public Function GetProxyTypes() As Type()
                        Return New Type() { GetType(SampleWebServiceApplicationProxy) }
                End Function
                Public Function GetProxyTypeDescription(ByVal serviceApplicationProxyType As Type) As SPPersistedTypeDescription
                        Return New SPPersistedTypeDescription("Sample Web Service Proxy", "Connects to the Sample Web Service.")
                End Function
                Public Function CreateProxy(ByVal serviceApplicationProxyType As Type, ByVal name As String, ByVal serviceApplicationUri As Uri, ByVal provisioningContext As SPServiceProvisioningContext) As SPServiceApplicationProxy
                        ' Create a proxy for the specified (typically remote) service application
                        Return New SampleWebServiceApplicationProxy(name, Me, serviceApplicationUri)
                End Function
                #End Region

See Also

Reference

IServiceProxyAdministration Members

Microsoft.SharePoint.Administration Namespace