CSLA.NET 5.4.2
CSLA .NET is a software development framework that helps you build a reusable, maintainable object-oriented business layer for your app.
Csla.Configuration.CslaDataPortalConfiguration Class Reference

Use this type to configure the settings for the CSLA .NET data portal. More...

Public Member Functions

CslaDataPortalConfiguration DefaultProxy (Type type, string defaultUrl)
 Configure the default data portal proxy type and URL. More...
 
CslaDataPortalConfiguration DefaultProxy (string typeName, string defaultUrl)
 Configure the default data portal proxy type and URL. More...
 
CslaDataPortalConfiguration ProxyDescriptors (List< Tuple< string, string, string > > descriptors)
 Adds resource/type to data portal proxy mappings for use by the data portal. More...
 
CslaDataPortalConfiguration ProxyFactoryType (Type type)
 summary> Sets the full type name (or 'Default') of the data portal proxy factory object to be used to get the DataPortalProxy instance to use when communicating with the data portal server. More...
 
CslaDataPortalConfiguration ProxyFactoryType (string typeName)
 
CslaDataPortalConfiguration ActivatorType (Type type)
 Sets the type of the IDataPortalActivator provider. More...
 
CslaDataPortalConfiguration ActivatorType (string typeName)
 Sets the type of the IDataPortalActivator provider. More...
 
CslaDataPortalConfiguration Activator (Server.IDataPortalActivator activator)
 Sets an instance of the IDataPortalActivator provider. More...
 
CslaDataPortalConfiguration AuthenticationType (string typeName)
 Sets the authentication type being used by the CSLA .NET framework. More...
 
CslaDataPortalConfiguration ServerAuthorizationProviderType (Type type)
 Sets the type name to be used for server-side data portal authorization. More...
 
CslaDataPortalConfiguration ServerAuthorizationProviderType (string typeName)
 Sets the type name to be used for server-side data portal authorization. More...
 
CslaDataPortalConfiguration InterceptorType (string typeName)
 Sets the type of interceptor invoked by the data portal for pre- and post-processing of each data portal invocation. More...
 
CslaDataPortalConfiguration InterceptorType (Type type)
 Sets the type of interceptor invoked by the data portal for pre- and post-processing of each data portal invocation. More...
 
CslaDataPortalConfiguration ExceptionInspectorType (Type type)
 Sets the type of the ExceptionInspector class. More...
 
CslaDataPortalConfiguration ExceptionInspectorType (string typeName)
 Sets the type name of the ExceptionInspector class. More...
 
CslaDataPortalConfiguration FactoryLoaderType (Type type)
 Sets the type of the factor loader used to create server-side instances of business object factories when using the FactoryDataPortal model. More...
 
CslaDataPortalConfiguration FactoryLoaderType (string typeName)
 Sets the type name of the factor loader used to create server-side instances of business object factories when using the FactoryDataPortal model. More...
 
CslaDataPortalConfiguration AutoCloneOnUpdate (bool value)
 Sets a value indicating whether objects should be automatically cloned by the data portal Update() method when using a local data portal configuration. More...
 
CslaDataPortalConfiguration DataPortalReturnObjectOnException (bool value)
 Gets or sets a value indicating whether the server-side business object should be returned to the client as part of the DataPortalException. More...
 
CslaDataPortalConfiguration DashboardType (Type type)
 Sets the assembly qualified type name of the dashboard, or 'Dashboard' for default, or 'NullDashboard' for the null dashboard. More...
 
CslaDataPortalConfiguration DashboardType (string typeName)
 Sets the assembly qualified type name of the dashboard, or 'Dashboard' for default, or 'NullDashboard' for the null dashboard. More...
 
CslaDataPortalConfiguration FlowSynchronizationContext (bool flow)
 Sets a value indicating whether any synchronization context should be flowed to child tasks by LocalProxy. More...
 

Detailed Description

Use this type to configure the settings for the CSLA .NET data portal.

Definition at line 31 of file CslaDataPortalConfiguration.cs.

Member Function Documentation

◆ Activator()

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.Activator ( Server.IDataPortalActivator  activator)

Sets an instance of the IDataPortalActivator provider.

Parameters
activatorActivator instance

Definition at line 144 of file CslaDataPortalConfiguration.cs.

◆ ActivatorType() [1/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ActivatorType ( string  typeName)

Sets the type of the IDataPortalActivator provider.

Parameters
typeNameAssembly qualified type name

Definition at line 134 of file CslaDataPortalConfiguration.cs.

◆ ActivatorType() [2/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ActivatorType ( Type  type)

Sets the type of the IDataPortalActivator provider.

Parameters
typeActivator type

Definition at line 124 of file CslaDataPortalConfiguration.cs.

◆ AuthenticationType()

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.AuthenticationType ( string  typeName)

Sets the authentication type being used by the CSLA .NET framework.

Parameters
typeNameAuthentication type value (defaults to 'Csla')

Definition at line 155 of file CslaDataPortalConfiguration.cs.

◆ AutoCloneOnUpdate()

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.AutoCloneOnUpdate ( bool  value)

Sets a value indicating whether objects should be automatically cloned by the data portal Update() method when using a local data portal configuration.

Parameters
valueValue (defaults to true)

Definition at line 263 of file CslaDataPortalConfiguration.cs.

◆ DashboardType() [1/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.DashboardType ( string  typeName)

Sets the assembly qualified type name of the dashboard, or 'Dashboard' for default, or 'NullDashboard' for the null dashboard.

Parameters
typeNameAssembly qualified type name
Returns

Definition at line 299 of file CslaDataPortalConfiguration.cs.

◆ DashboardType() [2/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.DashboardType ( Type  type)

Sets the assembly qualified type name of the dashboard, or 'Dashboard' for default, or 'NullDashboard' for the null dashboard.

Parameters
typeDashboard type
Returns

Definition at line 287 of file CslaDataPortalConfiguration.cs.

◆ DataPortalReturnObjectOnException()

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.DataPortalReturnObjectOnException ( bool  value)

Gets or sets a value indicating whether the server-side business object should be returned to the client as part of the DataPortalException.

Parameters
valueValue (default is false)

Definition at line 275 of file CslaDataPortalConfiguration.cs.

◆ DefaultProxy() [1/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.DefaultProxy ( string  typeName,
string  defaultUrl 
)

Configure the default data portal proxy type and URL.

Parameters
typeNameAssembly qualified type name
defaultUrlDefault server URL
Returns

Definition at line 51 of file CslaDataPortalConfiguration.cs.

◆ DefaultProxy() [2/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.DefaultProxy ( Type  type,
string  defaultUrl 
)

Configure the default data portal proxy type and URL.

Parameters
typeType of data portal proxy
defaultUrlDefault server URL
Returns

Definition at line 39 of file CslaDataPortalConfiguration.cs.

◆ ExceptionInspectorType() [1/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ExceptionInspectorType ( string  typeName)

Sets the type name of the ExceptionInspector class.

Type must implement IDataPortalExceptionInspector.

Parameters
typeNameAssembly qualified type name

Definition at line 225 of file CslaDataPortalConfiguration.cs.

◆ ExceptionInspectorType() [2/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ExceptionInspectorType ( Type  type)

Sets the type of the ExceptionInspector class.

Type must implement IDataPortalExceptionInspector.

Parameters
typeInspector type

Definition at line 214 of file CslaDataPortalConfiguration.cs.

◆ FactoryLoaderType() [1/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.FactoryLoaderType ( string  typeName)

Sets the type name of the factor loader used to create server-side instances of business object factories when using the FactoryDataPortal model.

Type must implement IObjectFactoryLoader.

Parameters
typeNameAssembly qualified type name

Definition at line 251 of file CslaDataPortalConfiguration.cs.

◆ FactoryLoaderType() [2/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.FactoryLoaderType ( Type  type)

Sets the type of the factor loader used to create server-side instances of business object factories when using the FactoryDataPortal model.

Type must implement IObjectFactoryLoader.

Parameters
typeFactory loader type

Definition at line 238 of file CslaDataPortalConfiguration.cs.

◆ FlowSynchronizationContext()

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.FlowSynchronizationContext ( bool  flow)

Sets a value indicating whether any synchronization context should be flowed to child tasks by LocalProxy.

Setting this to true may restrict or eliminate the use of background threads by LocalProxy.

Parameters
flowTrue to flow context
Returns

Definition at line 315 of file CslaDataPortalConfiguration.cs.

◆ InterceptorType() [1/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.InterceptorType ( string  typeName)

Sets the type of interceptor invoked by the data portal for pre- and post-processing of each data portal invocation.

Type must implement IInterceptDataPortal.

Parameters
typeNameAssembly qualified type name

Definition at line 190 of file CslaDataPortalConfiguration.cs.

◆ InterceptorType() [2/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.InterceptorType ( Type  type)

Sets the type of interceptor invoked by the data portal for pre- and post-processing of each data portal invocation.

Type must implement IInterceptDataPortal.

Parameters
typeInterceptor type

Definition at line 203 of file CslaDataPortalConfiguration.cs.

◆ ProxyDescriptors()

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ProxyDescriptors ( List< Tuple< string, string, string > >  descriptors)

Adds resource/type to data portal proxy mappings for use by the data portal.

Parameters
descriptorsData portal type/resource to proxy mapping
Returns

summary> Sets the type for the data portal proxy factory object to be used to get the DataPortalProxy instance to use when communicating with the data portal server.

Parameters
typeProxy factory type

Definition at line 64 of file CslaDataPortalConfiguration.cs.

◆ ProxyFactoryType() [1/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ProxyFactoryType ( string  typeName)

Definition at line 114 of file CslaDataPortalConfiguration.cs.

◆ ProxyFactoryType() [2/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ProxyFactoryType ( Type  type)

summary> Sets the full type name (or 'Default') of the data portal proxy factory object to be used to get the DataPortalProxy instance to use when communicating with the data portal server.

Parameters
typeNameAssembly qualified type name

Definition at line 101 of file CslaDataPortalConfiguration.cs.

◆ ServerAuthorizationProviderType() [1/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ServerAuthorizationProviderType ( string  typeName)

Sets the type name to be used for server-side data portal authorization.

Type must implement IAuthorizeDataPortal.

Parameters
typeNameAssembly qualified type name

Definition at line 177 of file CslaDataPortalConfiguration.cs.

◆ ServerAuthorizationProviderType() [2/2]

CslaDataPortalConfiguration Csla.Configuration.CslaDataPortalConfiguration.ServerAuthorizationProviderType ( Type  type)

Sets the type name to be used for server-side data portal authorization.

Type must implement IAuthorizeDataPortal.

Parameters
typeAuthorization provider type

Definition at line 166 of file CslaDataPortalConfiguration.cs.