Hands-On Lab. Lab 13: Developing Sandboxed Solutions for Web Parts. Lab version: Last updated: 2/23/2011

Transcription

1 Hands-On Lab Lab 13: Developing Sandboxed Solutions for Web Parts Lab version: Last updated: 2/23/2011

2 CONTENTS OVERVIEW... 3 EXERCISE 1: CREATING THE VISUAL STUDIO 2010 PROJECT... 3 EXERCISE 2: CALLING SPSECURITY... 6 EXERCISE 3: CALLING A CAS SECURED METHOD... 9

3 Overview Lab Time: 45 minutes Lab Folder: C:\Student\Labs\13_SandboxedSolutions Lab Overview: The support for sandboxed solutions provides an important new deployment mechanism for SharePoint. With a development methodology that is the same for full solutions the key focus point is not on what to build, but on what can be built. In this lab exercise you will construct a basic Web Part that will call into the SharePoint API to retrieve some information. Next it will try and use SPSecurity to try and elevate privileges. The third and last action that is added is an attempt to initiate a HTTP connection to an external site. Lab Setup Requirements Before you begin this lab, you must run the batch file named SetupLab13.bat. This batch file runs a PowerShell script which creates a new SharePoint site collection at the location Exercise 1: Creating the Visual Studio 2010 Project In this first exercise you will create a new SharePoint project and set it up for sandboxed deployment. You will also author and test the first version of the Web Part. 1. If you haven t already done so, run the batch file named SetupLab13.bat, found in the c:\student\labs\13_sandboxsolutions\ folder, to create the new site collection that will be used to test and debug the code you will be writing in this lab. This batch file creates a new site collection at an URL of 2. Before you can deploy sandboxed solutions to the SharePoint server, your server must be configured for this. Open SharePoint 2010 Central Administration and choose System Settings >> Manage services on server. Locate the Microsoft SharePoint Foundation Sandboxed Code Service and check its status. If it s Stopped, click the Start hyperlink to start the service. 3. Open Visual Studio 2010 and choose to create a new project. Pick Empty SharePoint Project as the template which you find under the Visual C#/Visual Basic» SharePoint» 2010 template

4 group. Name the project SandboxedWebPart. A wizard will appear allowing you to configure the project. 4. Complete the SharePoint Customization Wizard using the following information: a. Debugging site: b. Deploy as a sandboxed solution c. Click Finish 5. Using the Solution Explorer, right-click the SandboxedWebPart project and select Add» New Item. Complete the dialog that appears using the following information. a. Visual C#/Visual Basic» SharePoint» 2010 b. Template: Web Part c. Name: WebPart1 Figure 1 Create a web part 6. Using the Solution Explorer, expand Features, right-click Feature1 and choose View Designer. In the designer that appears, verify the Scope. It should be set to Site. Figure 2 Change the feature scope 7. In the WebPart1.cs/vb tab that opens, locate the WebPart1 class. Add the following code: C# protected override void CreateChildControls() Label message = new Label(); Controls.Add(message);

5 VB.NET Controls.Add(new WebControl(HtmlTextWriterTag.Br)); Button testbutton1 = new Button(); testbutton1.text = "Test 1"; testbutton1.click += delegate message.text = String.Format("This site contains 0 lists", SPContext.Current.Web.Lists.Count); ; Controls.Add(testButton1); Public Class WebPart1 Inherits WebPart Dim message As New Label() Protected Overrides Sub CreateChildControls() Controls.Add(message) Controls.Add(New WebControl(HtmlTextWriterTag.Br)) Dim testbutton1 As New Button() AddHandler testbutton1.click, AddressOf testbutton1_click testbutton1.text = "Test 1" Controls.Add(testButton1) Private Sub testbutton1_click(byval sender As Object, ByVal e As EventArgs) message.text = [String].Format("This site contains 0 lists", SPContext.Current.Web.Lists.Count) End Class 8. Right click the project in Solution Explorer and choose Deploy in order to deploy the web part. 9. Open a browser and navigate to the site. 10. On the ribbon, select the Page tab and choose Edit. 11. Select a Web Part Zone and then click the on the Insert tab in the Editing Tools tab group on the ribbon. 12. Click the Web Part button in order to show the Web Part pane. 13. On the Web Part pane, select the Custom group, then select WebPart1 and click the Add button. 14. On the ribbon, select the Page tab and then select Save & Close from the Edit Section of this tab to stop editing the page.

6 Figure 3 Add the web part to the home page 15. On the WebPart1, click the Test 1 button in order to test calling the context site collection. The page should refresh displaying a message of how many lists are in the current site: Figure 4 Execute the Test 1 button In this exercise you created a new sandboxed Web Part that contained code that is allowed to run in the sandbox. Exercise 2: Calling SPSecurity In this second exercise you will add code to the Web Part that will call SPSecurity. You will redeploy and test the Web Part by simply starting debugging from Visual Studio. 1. In the WebPart1 class, add the following code to the CreateChildControls method that you have added earlier. This code will utilize the SPSecurity object. C# protected override void CreateChildControls() // CODE OMMITTED FOR BREVITY Controls.Add(testButton1); Button testbutton2 = new Button(); testbutton2.text = "Test 2"; testbutton2.click += delegate try SPSecurity.RunWithElevatedPrivileges( delegate using (SPSite sitecollection = new SPSite(SPContext.Current.Site.ID))

7 SPWeb site = sitecollection.openweb(spcontext.current.web.id); message.text = String.Format("This site contains 0 lists", site.lists.count); ); catch (Exception e) message.text = e.message; ; Controls.Add(testButton2); VB.NET <ToolboxItemAttribute(false)> _ Public Class WebPart1 Inherits WebPart Dim message As New Label() Protected Overrides Sub CreateChildControls() Controls.Add(message) Controls.Add(New WebControl(HtmlTextWriterTag.Br)) Dim testbutton1 As New Button() AddHandler testbutton1.click, AddressOf testbutton1_click testbutton1.text = "Test 1" Controls.Add(testButton1) Dim testbutton2 As New Button() testbutton2.text = "Test 2" AddHandler testbutton2.click, AddressOf testbutton2_click Controls.Add(testButton2) Private Sub testbutton1_click(byval sender As Object,ByVal e As EventArgs) message.text = [String].Format("This site contains 0 lists",spcontext.current.web.lists.count) Private Sub testbutton2_click(byval sender As Object, ByVal e As EventArgs) SPSecurity.RunWithElevatedPrivileges(AddressOf ElevateMe) Private Sub ElevateMe() Try Using sitecollection As New SPSite(SPContext.Current.Site.ID)

8 Dim site As SPWeb =sitecollection.openweb(spcontext.current.web.id) message.text = [String].Format("This site contains 0 lists", site.lists.count) End Using Catch e As Exception message.text = e.message End Try End Class 2. Right click the project in Solution Explorer and choose Deploy in order to deploy the web part. 3. If you have your browser still open from previous exercise, press F5 to refresh the page. If you closed the browser, open it again and navigate to Figure 1 Test 1 and Test 2 buttons 4. On the WebPart1, click the Test 2 button in order to test the call to SPSecurity. 5. Notice that an exception is thrown. Also notice that the exception details are hidden by default. Click on the Show Error Details. This error shows that this Web Part, which is running in the sandbox, cannot include a reference to the SPSecurity type: Figure 5

9 Security exception 6. Close the browser. In this exercise you added code to your sandboxed Web Part that included a reference to SPSecurity which is not permitted within the sandbox. Exercise 3: Calling a CAS secured method In this exercise you will add code to the Web Part that tries and perform a CAS security protected task. In the sample a HTTP connection is attempted. 1. In the WebPart1 class, add the following code to the CreateChildControls method that you have added earlier. This code will issue a standard Web request. C# protected override void CreateChildControls() // CODE OMMITTED FOR BREVITY Controls.Add(testButton1); VB.NET // CODE OMMITTED FOR BREVITY Controls.Add(testButton2); Button testbutton3 = new Button(); testbutton3.text = "Test 3"; testbutton3.click += delegate try System.Net.HttpWebRequest.Create(" catch (Exception e) message.text = e.message; ; Controls.Add(testButton3); <ToolboxItemAttribute(false)> Public Class WebPart1 Inherits WebPart Dim message As New Label()

10 Protected Overrides Sub CreateChildControls() Controls.Add(message) Controls.Add(New WebControl(HtmlTextWriterTag.Br)) Dim testbutton1 As New Button() AddHandler testbutton1.click, AddressOf testbutton1_click testbutton1.text = "Test 1" Controls.Add(testButton1) Dim testbutton2 As New Button() testbutton2.text = "Test 2" AddHandler testbutton2.click, AddressOf testbutton2_click Controls.Add(testButton2) Dim testbutton3 As New Button() testbutton3.text = "Test 3" AddHandler testbutton3.click, AddressOf testbutton3_click Controls.Add(testButton3) ' CODE OMMITTED FOR BREVITY Private Sub testbutton3_click(byval sender As Object,ByVal e As EventArgs) Try System.Net.HttpWebRequest.Create(" Catch e1 As Exception message.text = e1.message End Try End Class 2. On the Debug menu, choose Start Debugging in order to deploy and test the Web Part, or just press [F5]. When the browser opens, it will automatically take you to the site. Figure 6 All 3 buttons on WebPart1 3. On the WebPart1, click the Test 3 button in order to test creating an HTTP connection. 4. Notice that an exception is thrown because the sandbox is running in a special CAS policy that blocks all System.Net.WebPermission demands, as the HttpWebRequest object does.

11 Figure 7 A Permission exception 5. Close the browser in order to stop debugging. In this exercise you added code that is blocked by the sandbox CAS policy because it demands a permission not allowed by the CAS policy.